This format should be used when sending shipments to the retailer/brand. The below format is recommended to send a compliant shipment to the retailer/brand. In some cases partners may require less or more data depending on your relationship with them and the products that are being sold. The CSV header will directly correspond with the Commerce API fields. To add additional fields you can add the field name as the column, if the field is nested you can use "." to indicate the child element.
For Example: if you want to enter a CompanyName for the ShipToAddress the CSV column name would be ShipToAddress.CompanyName
"ShipToAddress": {
"CompanyName": "RIJENNIFER LEWIS",
},
Attached below is a sample CSV.
Field |
Example |
Description |
User Requirement |
Identifier.LinkKey |
string |
Used to link the document to the original source document. For example, It is best to supply the Order's linkkey when posting a shipment. This will make sure the order shipped quanitites are updated on the original order and all statuses are updated appropriateley. |
Optional |
ReceiverCompanyId |
0 |
Logicbroker Internal Company ID to specify what company is to receive the document. |
Required |
Type |
0 |
Indicates how the acknowledgement will be treated. 0 = AcknowledgeWithChange 1 = Acknowledge 2 = Reject |
Optional |
DocumentDate |
2016-04-22T204522.79 |
Date the document was created in the logicbroker system. |
Required |
AcknowledgementNumber |
ACK_1599999999 |
Unique Identifier used to identify the acknowledgment |
Required |
ChangeReason |
ChangeReason |
Free form text for reason of cancellation or acceptance. For certain partners this may require a specific code. |
Optional |
OrderDate |
2013-10-31 |
Date on the Purchase Order |
Required |
OrderNumber |
2152252 |
Contains the end customer's order number, this will be used on the packing slip. |
Required |
PartnerPO |
1599999999 |
This will be the purcahse order number, this will be the main Key to link all your documents. |
Required |
ScheduledShipDate |
2015-11-06 |
Date requested for order to leave the warehouse/shipping location. |
Optional |
VendorNumber |
V12345 |
This is the internal vendor number provided to the supplier from the merchant |
Optional |
BillToAddress.CompanyName |
Merchant Co |
|
Required |
BillToAddress.FirstName |
Jerry |
|
Optional |
BillToAddress.LastName |
Only |
|
Optional |
BillToAddress.Address1 |
111 Merchant Lane |
|
Required |
BillToAddress.Address2 |
Apt 1 |
|
Optional |
BillToAddress.City |
Yonkers |
|
Required |
BillToAddress.State |
NY |
|
Required |
BillToAddress.Country |
USA |
|
Optional |
BillToAddress.Zip |
10704 |
|
Required |
BillToAddress.AddressCode |
1234567890 |
Address code that will indicate the location where the address is related to. Typically will be a store or DC number. |
Optional |
BillToAddress.Phone |
111-222-3333 |
|
Optional |
BillToAddress.Email |
|
Optional |
|
ShipToAddress.CompanyName |
Merchant Co |
|
Required |
ShipToAddress.FirstName |
Jerry |
|
Optional |
ShipToAddress.LastName |
Only |
|
Optional |
ShipToAddress.Address1 |
111 Merchant Lane |
|
Required |
ShipToAddress.Address2 |
Apt 1 |
|
Optional |
ShipToAddress.City |
Yonkers |
|
Required |
ShipToAddress.State |
NY |
|
Required |
ShipToAddress.Country |
USA |
|
Optional |
ShipToAddress.Zip |
10704 |
|
Required |
ShipToAddress.AddressCode |
1234567890 |
Address code that will indicate the location where the address is related to. Typically will be a store or DC number. |
Optional |
ShipToAddress.Phone |
111-222-3333 |
|
Optional |
ShipToAddress.Email |
Merchant@co.com |
|
Optional |
AckLines.Description |
BLOUSE |
Standard short description or name of the product. |
Optional |
AckLines.RetailPrice |
47.98 |
Unit Price to be charged to the customer or end receiver. This will typically be the value on the packing slip. |
Optional |
AckLines.Type |
0 |
Used to identify what type of acknowledgement this is. For additional details please enter in a Change Reason. 0=ItemAccepted 1=ItemBackordered 2=ItemRejected |
Optional |
AckLines.LineNumber |
1 |
Purchase order line number. |
Required |
AckLines.Price |
31.02 |
Unit cost that the merchant expects to be billed for each unit fulfilled. |
Optional |
AckLines.PriceCode |
WH |
Used to indicate the price level for the product. See specific partner details for applicable codes. |
Optional |
AckLines.Quantity |
5 |
Used to list the quantity being acknowledged for this product. The acknowledgement type will be determined by the what is supplied in the "Type" and "ChangeReason" fields. |
Required |
AckLines.QuantityCancelled |
6 |
If this value is provided, Qty will get automatically updated and the change reason will get updated appropriately. |
Required |
AckLines.QuantityBackordered |
7 |
If this value is provided, Qty will get automatically updated and the change reason will get updated appropriately. |
Required |
AckLines.QuantityUOM |
EA |
Unit of Measure for the quantity ordered. See partner's details for specifics. |
Required |
AckLines.ItemIdentifier.ISBN |
string |
International Standard Book Number |
Optional |
AckLines.ItemIdentifier.ManufacturerSKU |
25252 |
Manufacturer's ID for the product. |
Optional |
AckLines.ItemIdentifier.PartnerSKU |
J07874 |
The Item identifier that is internal to the purchaser/merchant. |
Optional |
AckLines.ItemIdentifier.SupplierSKU |
49-98760 |
The Item Identifier that is used by the supplier or the person fulfilling the product. |
Required |
AckLines.ItemIdentifier.UPC |
123456789012 |
Typically the U.P.C Consumer Package code will be provided; however additional standardized codes can be provided here as well. See specific partner instructions for details. |
Optional |
AckLines.ChangeReason |
ItemChangeReason |
Free Form Reason for cancellation, or acceptance of line item. For certain partners this may require a specific code. |
Optional |
AckLines.ExtendedAttribute.Color |
Blue |
Color code used to identify specific product Attribute. Can also include color description; see specific partner for details. |
Optional |
AckLines.ExtendedAttribute.Size |
SIZE 15 |
Size identifier for the product. |
Optional |
Comments
0 comments
Please sign in to leave a comment.