Order Pack
Shipment:
ShipmentHeader
ShipmentHeader
Shipment header object
ShipmentCartonList
List<ShipCartonObj>
List of shipment carton objects
UnCartonizedLines
List<ShipCartonDetail>
List of uncartonized shipment carton details
ShipmentHeader:
Id
long
Identifier for the shipment header
ShipmentNumber
string
Shipment number
StatusId
int
Status ID
CarrierId
int?
Carrier ID
ShippingTermsId
int
Shipping terms ID
FobId
int
FOB ID
ShippingNotes
string
Notes about the shipping
ShippingCostCharged
double
Charged shipping cost
ShippingCostCarrier
double
Shipping cost paid to the carrier
ShippingCost
double
Shipping cost
ShippingTaxAmount
double
Tax amount on the shipping cost
ShippingMethodId
int
Shipping method ID
OriginRefId
long?
Origin reference ID
OriginRefNumber
string
Origin reference number
OriginTypeId
int
Origin type ID
OriginTypeName
string
Origin type name
CreateDttm
DateTime
Creation date and time
CreateSource
string
Source of creation
ModifyDttm
DateTime?
Modification date and time
ModifySource
string
Source of modification
TaxCodeId
int?
Tax code ID
ShipToContact
string
Contact information of the recipient
ShipToAddr1
string
Address line 1 of the recipient
ShipToAddr2
string
Address line 2 of the recipient
ShipToCity
string
City of the recipient
ShipToState
string
State of the recipient
ShipToCountry
string
Country of the recipient
ShipToPostalCode
string
Postal code of the recipient
ShipToCompanyName
string
Company name of the recipient
ShipToPhoneNumber
string
Phone number of the recipient
ShipToEmail
string
Email address of the recipient
ShipToResidentialFlag
bool
Flag indicating if the recipient's address is residential
ShippingCostAllocated
double
Allocated shipping cost
ShippingCostInvoiced
double
Invoiced shipping cost
ShippingCostRemaining
double
Remaining shipping cost
ShippingCostEffective
double
Effective shipping cost
LinkedRefId
long
Linked reference ID
LinkedRefNumber
string
Linked reference number
LinkedTypeId
int
Linked type ID
LinkedTypeName
string
Linked type name
ShipFromAddr1
string
Address line 1 of the shipper
ShipFromAddr2
string
Address line 2 of the shipper
ShipFromCity
string
City of the shipper
ShipFromState
string
State of the shipper
ShipFromCountry
string
Country of the shipper
ShipFromPostalCode
string
Postal code of the shipper
ShipFromCompanyName
string
Company name of the shipper
ShipFromEmail
string
Email address of the shipper
FreeShippingFlag
bool
Flag indicating if the shipping is free
ShippingOverrideFlag
bool
Flag indicating if there is a shipping override
ShippingTermsName
string
Name of the shipping terms
ShipMethodName
string
Name of the shipping method
ShipmentStatus
string
Status of the shipment
CarrierName
string
Name of the carrier
FobName
string
Name of the FOB
EditState
bool
State indicating if the shipment is in edit mode
ShipDate
DateTime?
Date of shipment
ShipFromContact
string
Contact information of the shipper
ShipFromPhoneNumber
string
Phone number of the shipper
ThirdPartyAccountNumber
string
Account number of the third party
ThirdPartyAccountCountry
string
Country of the third party
ThirdPartyAccountPostalZipCode
string
Postal code of the third party
IsInternationalShipment
bool
Flag indicating if it's an international shipment
ContentsCode
string
Code for the contents of the shipment
NonDeliveryCode
string
Code for non-delivery
CurrencyId
int
Currency ID
ShippingExpenseAccntId
string
ID of the shipping expense account
MasterBOLNumber
string
Master bill of lading number
BOLNumber
string
Bill of lading number
MasterTrackingNumber
string
Master tracking number
ShipmentRefNumber
string
Shipment reference number
ContainerRefNumber
string
Container reference number
CustomerPoNumber
string
Customer purchase order number
ShippingTaxData
TaxData
Tax data related to shipping
CarrierCustomField1
string
Custom field 1 of the carrier
CarrierCustomField2
string
Custom field 2 of the carrier
CarrierCustomField3
string
Custom field 3 of the carrier
SoNumber
string
Sales order number
SoRefNumber
string
Sales order reference number
ThirdPartyShipmentRefNumber
string
Third-party shipment reference number
ShippingAccruedAccountId
string
ID of the shipping accrued account
IsShippingAccrued
bool
Flag indicating if the shipping is accrued
ShipServiceCode
string
Service code for the shipment
TotalCartonCount
int?
Total count of cartons in the shipment
ShipCartonObj:
ShipCartonHeaderObj
ShipCartonHeader
Ship carton header object
ReturnShipCartonHeaderObj
ReturnShipCartonHeader
Return ship carton header object
ShipCartonDetailList
List<ShipCartonDetail>
List of ship carton detail objects
ShipmentCartonHeaderObj:
Id
long
Identifier for the ship carton header
ShipmentId
long
Shipment ID associated with the ship carton
CartonNumber
int
Carton number
CartonLabel
string
Label of the carton
Length
double
Length of the carton
Width
double
Width of the carton
Height
double
Height of the carton
Weight
double
Weight of the carton
SizeUomId
int
Size unit of measure ID
WeightUomId
int
Weight unit of measure ID
TrackingNumber
string
Tracking number
PackageTypeId
int
Package type ID
ShipServiceId
int
Ship service ID
Sscc
string
SSCC (Serial Shipping Container Code)
DeclaredCost
double
Declared cost of the carton
CreateDttm
DateTime
Creation date and time
CreateSource
string
Source of creation
ModifyDttm
DateTime?
Modification date and time
ModifySource
string
Source of modification
Note
string
Note related to the carton
StatusId
int
Status ID
ShippingCostCharged
double
Charged shipping cost
ShippingCostCarrier
double
Shipping cost paid to the carrier
ShippingCostWMarkup
double
Shipping cost with markup
CurrencyId
int?
Currency ID
ExchangeRate
double?
Exchange rate
PackageTypeName
string
Name of the package type
ShipServiceName
string
Name of the ship service
WeightUomName
string
Name of the weight unit of measure
WeightUomCode
string
Code of the weight unit of measure
SizeUomName
string
Name of the size unit of measure
SizeUomCode
string
Code of the size unit of measure
CarrierId
int?
Carrier ID
CarrierName
string
Name of the carrier
CarrierConfCodeId
int?
Carrier confirmation code ID
CarrierConfCodeName
string
Name of the carrier confirmation code
ShipServiceCode
string
Code of the ship service
ShipDate
DateTime?
Date of shipment
CarrierCode
string
Code of the carrier
CarrierConfCode
string
Confirmation code of the carrier
PackageTypeCode
string
Code of the package type
LabelUrl
string
URL of the carton label
LabelCreatedFlag
bool
Flag indicating if the carton label is created
ReturnLabelCreatedFlag
bool
Flag indicating if the return label is created
ThirdPartyRefId
string
Reference ID of the third party
ThirdPartyShippingAppId
string
ID of the third-party shipping application
MasterBOLNumber
string
Master Bill of Lading number
BOLNumber
string
Bill of Lading number
MasterTrackingNumber
string
Master tracking number
ShipmentRefNumber
string
Shipment reference number
ContainerRefNumber
string
Container reference number
ReturnLabelTrackingNumber
string
Tracking number of the return label
ReturnLabelUrl
string
URL of the return label
LabelData
string
Data of the carton label
MasterCartonIndicator
bool
Indicator if it's a master carton
ThirdPartyMasterCartonId
string
ID of the third-party master carton
TotalCartonCount
int
Total count of cartons in the shipment
HasReturnLabel
bool
Flag indicating if the shipment has a return label
ShipCartonDetail:
Id
long
Identifier for the ship carton detail
ShipCartonId
long
Ship carton ID to which the detail belongs
RefLineId
long?
Reference line ID (nullable)
ItemId
long
Item ID
ItemNumber
string
Item number
Description
string
Description of the item
UomId
int
Unit of measure ID
Weight
double?
Weight of the item (nullable)
WeightUomId
int?
Weight unit of measure ID (nullable)
Qty
double
Quantity of the item
CreateDttm
DateTime
Creation date and time
CreateSource
string
Source of creation
ModifyDttm
DateTime?
Modification date and time (nullable)
ModifySource
string
Source of modification
Note
string
Note related to the item
HSCode
string
Harmonized System (HS) code
UnitPrice
double
Unit price of the item
Title
string
Title of the item
Upc
string
Universal Product Code (UPC)
ReturnShipCartonHeader:
Id
long
Identifier for the return ship carton header
ShipCartonId
long
Ship carton ID associated with the return carton
CartonLabel
string
Label of the return carton
Length
double?
Length of the return carton (nullable)
Width
double?
Width of the return carton (nullable)
Height
double?
Height of the return carton (nullable)
Weight
double
Weight of the return carton
SizeUomId
int?
Size unit of measure ID
WeightUomId
int
Weight unit of measure ID
PackageTypeId
int?
Package type ID
ShipServiceId
int?
Ship service ID
DeclaredCost
double
Declared cost of the return carton
CreateDttm
DateTime
Creation date and time
CreateSource
string
Source of creation
ModifyDttm
DateTime?
Modification date and time (nullable)
ModifySource
string
Source of modification
StatusId
int
Status ID
PackageTypeName
string
Name of the package type
ShipServiceName
string
Name of the ship service
WeightUomName
string
Name of the weight unit of measure
WeightUomCode
string
Code of the weight unit of measure
SizeUomName
string
Name of the size unit of measure
SizeUomCode
string
Code of the size unit of measure
CarrierId
int?
Carrier ID
CarrierName
string
Name of the carrier
ShipServiceCode
string
Code of the ship service
CarrierCode
string
Code of the carrier
PackageTypeCode
string
Code of the package type
LabelUrl
string
URL of the return carton label
LabelCreatedFlag
bool
Flag indicating if the return carton label is created
ThirdPartyRefId
string
Reference ID of the third party
ThirdPartyShippingAppId
string
ID of the third-party shipping application
TrackingNumber
string
Tracking number of the return carton
ReturnFromContactName
string
Contact name of the return from address
ReturnFromCompanyName
string
Company name of the return from address
ReturnFromAddr1
string
Address line 1 of the return from address
ReturnFromAddr2
string
Address line 2 of the return from address
ReturnFromCity
string
City of the return from address
ReturnFromState
string
State of the return from address
ReturnFromCountry
string
Country of the return from address
ReturnFromPostalCode
string
Postal code of the return from address
ReturnFromPhoneNumber
string
Phone number of the return from address
ReturnFromEmail
string
Email address of the return from address
ReturnToContactName
string
Contact name of the return to address
ReturnToCompanyName
string
Company name of the return to address
ReturnToAddr1
string
Address line 1 of the return to address
ReturnToAddr2
string
Address line 2 of the return to address
ReturnToCity
string
City of the return to address
ReturnToState
string
State of the return to address
ReturnToCountry
string
Country of the return to address
ReturnToPostalCode
string
Postal code of the return to address
ReturnToEmail
string
Email address of the return to address
ReturnToPhoneNumber
string
Phone number of the return to address
ReturnReason
string
Reason for the return
ReturnLabelData
string
Data of the return carton label
{
"ShipmentCartonList": [
{
"ReturnShipCartonHeaderObj": {
"CarrierCode": null,
"CarrierId": null,
"CarrierName": null,
"CartonLabel": null,
"CreateDttm": "01/01/0001 12:00:00 AM",
"CreateSource": null,
"DeclaredCost": 0.0,
"Height": null,
"Id": 0,
"LabelCreatedFlag": false,
"LabelUrl": null,
"Length": null,
"ModifyDttm": null,
"ModifySource": null,
"PackageTypeCode": null,
"PackageTypeId": null,
"PackageTypeName": null,
"ReturnFromAddr1": null,
"ReturnFromAddr2": null,
"ReturnFromCity": null,
"ReturnFromCompanyName": null,
"ReturnFromContactName": null,
"ReturnFromCountry": null,
"ReturnFromEmail": null,
"ReturnFromPhoneNumber": null,
"ReturnFromPostalCode": null,
"ReturnFromState": null,
"ReturnLabelData": null,
"ReturnLabelDataType": null,
"ReturnReason": null,
"ReturnToAddr1": null,
"ReturnToAddr2": null,
"ReturnToCity": null,
"ReturnToCompanyName": null,
"ReturnToContactName": null,
"ReturnToCountry": null,
"ReturnToEmail": null,
"ReturnToPhoneNumber": null,
"ReturnToPostalCode": null,
"ReturnToState": null,
"ShipCartonId": 0,
"ShipServiceCode": null,
"ShipServiceId": null,
"ShipServiceName": null,
"SizeUomCode": null,
"SizeUomId": null,
"SizeUomName": null,
"StatusId": 0,
"ThirdPartyRefId": null,
"ThirdPartyShippingAppId": null,
"TrackingNumber": null,
"Weight": 0.0,
"WeightUomCode": null,
"WeightUomId": 0,
"WeightUomName": null,
"Width": null
},
"ShipCartonDetailList": [
{
"CreateDttm": "07/13/2023 02:40:17 AM",
"CreateSource": "xoro@pushkar",
"Description": "eye wears",
"HSCode": "",
"Id": 64194,
"ItemId": 35266,
"ItemNumber": "#751",
"ModifyDttm": null,
"ModifySource": "",
"Note": "",
"Qty": 1.0,
"RefLineId": 91874,
"ShipCartonId": 61479,
"Title": "#751",
"UnitPrice": 44.0,
"UomId": 17,
"Upc": "",
"Weight": 0.0,
"WeightUomId": 3
}
],
"ShipCartonHeaderObj": {
"BOLNumber": null,
"CarrierCode": null,
"CarrierConfCode": "none",
"CarrierConfCodeId": 0,
"CarrierConfCodeName": "No Confirmation",
"CarrierId": 1339,
"CarrierName": "3PL Central UPS",
"CartonLabel": "Carton 1",
"CartonNumber": 1,
"ContainerRefNumber": null,
"CreateDttm": "07/13/2023 02:40:13 AM",
"CreateSource": "xoro@pushkar",
"CurrencyId": null,
"DeclaredCost": 44.0,
"ExchangeRate": null,
"Guid": "3E860B03-39EA-4966-B706-FEF0F8A8BBB8",
"HasReturnLabel": false,
"Height": null,
"Id": 61479,
"LabelCreatedFlag": false,
"LabelData": null,
"LabelDataType": 0,
"LabelUrl": "",
"Length": null,
"MasterBOLNumber": null,
"MasterCartonIndicator": false,
"MasterTrackingNumber": null,
"ModifyDttm": null,
"ModifySource": "",
"Note": "",
"PackageTypeCode": "",
"PackageTypeId": 0,
"PackageTypeName": "",
"ReturnLabelCreatedFlag": false,
"ReturnLabelTrackingNumber": null,
"ReturnLabelUrl": null,
"ShipDate": "07/13/2023",
"ShipmentId": 61001,
"ShipmentRefNumber": null,
"ShippingCostCarrier": 0.0,
"ShippingCostCharged": 0.0,
"ShippingCostWMarkup": 0.0,
"ShipServiceCode": "03",
"ShipServiceId": 23,
"ShipServiceName": "3PL Ground",
"SizeUomCode": null,
"SizeUomId": null,
"SizeUomName": "",
"Sscc": "",
"StatusId": 0,
"ThirdPartyMasterCartonId": null,
"ThirdPartyRefId": "",
"ThirdPartyShippingAppId": "",
"TotalCartonCount": 0,
"TrackingNumber": "",
"Weight": 0.0,
"WeightUomCode": null,
"WeightUomId": 1,
"WeightUomName": "kg",
"Width": null
}
}
],
"ShipmentHeader": {
"BOLNumber": "",
"CarrierCustomField1": null,
"CarrierCustomField2": null,
"CarrierCustomField3": null,
"CarrierId": 1339,
"CarrierName": "3PL Central UPS",
"ContainerRefNumber": "",
"ContentsCode": "",
"CreateDttm": "07/13/2023 02:40:13 AM",
"CreateSource": "xoro@pushkar",
"CurrencyId": 1,
"CustomerPoNumber": null,
"EditState": false,
"FobId": 20,
"FobName": "Destination",
"FreeShippingFlag": false,
"Id": 61001,
"IsInternationalShipment": false,
"IsShippingAccrued": true,
"LinkedRefId": 91364,
"LinkedRefNumber": "WMSStore-I001139",
"LinkedTypeId": 20,
"LinkedTypeName": "Invoice",
"MasterBOLNumber": "",
"MasterTrackingNumber": "",
"ModifyDttm": null,
"ModifySource": "",
"NonDeliveryCode": "",
"OriginRefId": 133816,
"OriginRefNumber": "WMSStore-S003066",
"OriginTypeId": 10,
"OriginTypeName": "Sales Order",
"ShipDate": "07/13/2023",
"ShipFromAddr1": "600 W 9TH ST STE 135",
"ShipFromAddr2": "",
"ShipFromCity": "LOS ANGELES",
"ShipFromCompanyName": "The Skyline",
"ShipFromContact": "lens kart",
"ShipFromCountry": "US",
"ShipFromEmail": "",
"ShipFromPhoneNumber": "",
"ShipFromPostalCode": "90015",
"ShipFromState": "CA",
"ShipmentNumber": "SH000797",
"ShipmentRefNumber": "",
"ShipmentStatus": "Draft",
"ShipMethodName": "Delivery (Third Party)",
"ShippingAccruedAccountId": "72C4A3871166068A9A4A808E842E9",
"ShippingCost": 0.0,
"ShippingCostAllocated": 0.0,
"ShippingCostCarrier": 0.0,
"ShippingCostCharged": 0.0,
"ShippingCostEffective": 0.0,
"ShippingCostInvoiced": 0.0,
"ShippingCostRemaining": 0.0,
"ShippingExpenseAccntId": "72C4A387116608FF992C3B9FA4A64",
"ShippingMethodId": 30,
"ShippingNotes": "",
"ShippingOverrideFlag": false,
"ShippingTaxAmount": 0.0,
"ShippingTaxData": {
"taxItems": [],
"totalAmount": 0.0
},
"ShippingTermsId": 10,
"ShippingTermsName": "Prepaid",
"ShipServiceCode": "03",
"ShipToAddr1": "1448 N. Krome Ave.",
"ShipToAddr2": "Suite #103",
"ShipToCity": "Florida City",
"ShipToCompanyName": "XoroTest3",
"ShipToContact": "Test3 Automation3",
"ShipToCountry": "US",
"ShipToEmail": "[email protected]",
"ShipToPhoneNumber": "",
"ShipToPostalCode": "33034",
"ShipToResidentialFlag": false,
"ShipToState": "FL",
"SoNumber": "WMSStore-S003066",
"SoRefNumber": "166321",
"StatusId": 360,
"TaxCodeId": null,
"ThirdPartyAccountCountry": "",
"ThirdPartyAccountNumber": "",
"ThirdPartyAccountPostalZipCode": "",
"ThirdPartyShipmentRefNumber": null,
"TotalCartonCount": 1
},
"UnCartonizedLines": null
}Last updated