All data formats for all integrations are provided below. XML structure will be the same as JSON.
For actual samples see these articles:
EDI Field |
JSON |
CSV Field Name |
Description |
User Requirement |
|
{ |
|
|
|
|
"Identifier": { |
|
|
|
|
"SourceKey": "1599999990", |
|
Identifier that will come from the source system; typically this will match the PartnerPO. |
Read Only |
|
"LogicbrokerKey": "string", |
Identifier.LogicbrokerKey |
ID to identify the document in the logicbroker system. Required to save this in your system to prevent duplicates. |
Read Only |
|
"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 |
|
}, |
|
|
|
|
"SenderCompanyId": 0, |
SenderCompanyId |
Logicbroker Internal Company ID to specify what company is sending the document. |
Required |
|
"ReceiverCompanyId": 0, |
ReceiverCompanyId |
Logicbroker Internal Company ID to specify what company is to receive the document. |
Required |
|
"StatusCode": 0, |
|
This will be used to identify the status of your order. This is tied to all the documents associated with it. 0 (New) = All documents start at New and will quickly move to submitted. 100 (Submitted) = Status used when order is first received, once the order is picked up it should be moved to the next status, typically this will be 500 (Ready to Ship). For most partners the order will rarely stay in this status and can be picked up on 500 (Ready to Ship). 500 (Ready to Ship) = Indicates the order is pending shipment and waiting on the shipment. Once this shipment is sent the order shipped quantity will be updated and when all items have been shipped the status will automatically move to 600 (Ready to Invoice). 1000 (Complete) = Order flow is complete and all necessary documents have been received and processed for it. Some flows can include Acknowledgement, Shipment, and Invoice. 1100 (Cancelled) = Indicates the order and all line items have been cancelled. If you are sending an Acknowledgement as a cancellation, the status will need to be moved to this status and will not be done automatically. 1200 (Failed) = The status will indicate there was an error processing the order. Will go to this status automatically if the order fails to send via EDI, or has failed validation rules. See the events associated with the order to see the reason for the failure. |
Required |
N/A |
"DocumentDate": "2016-04-22T20:45:22.79", |
|
Date the document was created in the logicbroker system. |
Required |
BEG05 |
"OrderDate": "2013-10-31", |
OrderDate |
Date on the Purchase Order |
Required |
REF02 (CO) |
"OrderNumber": "002152252", |
OrderNumber |
Contains the end customer's order number, this will be used on the packing slip. |
Required |
BEG03 |
"PartnerPO": "1599999999", |
PartnerPO |
This will be the purcahse order number, this will be the main Key to link all your documents. |
Required |
BEG02 |
"TypeCode": "SA", |
TypeCode |
Purchase Order Type Code will indicate what type of PO is being sent. Examples are shown below. "SA" Stand Alone |
Required |
|
"Discounts": [ { |
|
|
|
|
} ], |
|
|
|
|
"PaymentTerm": { |
|
|
|
|
}, |
|
|
|
|
"ShipmentInfos": [ { |
|
|
|
TD503 |
"CarrierCode": "string", |
ShipmentInfo.CarrierCode |
This will typically be the Standard Carrier Alpha Code (SCAC). UPSN or USPS will be used. |
Optional |
TD505 |
"ClassCode": "UPSN_CG", |
ShipmentInfo.ClassCode |
The shipping method that will be used to send the merchandise. Following codes can be sent: UPSN-CG USPS UPSN-SC UPS-Express UPSN-3D UPSN-ND |
Required |
TD512 |
"ServiceLevelCode": "string" |
ShipmentInfo.ServiceLevelCode |
Service Level set to ship by the carrier. Check with trading partner to see applicable codes. An example of a few would be: ND = Next Day CG = Ground SC = Second Day Air 3D = 3 Day |
Optional |
|
} ], |
|
|
|
|
"Taxes": [ { |
|
|
|
|
} ], |
|
|
|
|
"BillToAddress": { |
|
Address for whom the order will be billed to. |
Optional |
|
}, |
|
|
|
|
"OrderedByAddress": { |
|
This is the bill to address for the end customer. This is typically used for dropship orders. |
Optional |
N104 |
"AddressCode": "1234567890", |
OrderedByAddress.AddressCode |
Sears Ordering Unit Number, will be used to identify the return address for the end customer. Return Address list is supplied here. |
Required |
N102 |
"CompanyName": "Merchant Co", |
OrderedByAddress.CompanyName |
|
Required |
N301 |
"Address1": "111 Merchant Lane", |
OrderedByAddress.Address1 |
|
Required |
N302 |
"Address2": "Apt 1", |
OrderedByAddress.Address2 |
|
Optional |
N401 |
"City": "Yonkers", |
OrderedByAddress.City |
|
Required |
N402 |
"State": "NY", |
OrderedByAddress.State |
|
Required |
N403 |
"Zip": "10704", |
OrderedByAddress.Zip |
|
Required |
|
}, |
|
|
|
|
"ShipToAddress": { |
|
Address where the order will be shipped |
Required |
N102 |
"CompanyName": "Merchant Co", |
ShipToAddress.CompanyName |
|
Required |
N301 |
"Address1": "111 Merchant Lane", |
ShipToAddress.Address1 |
|
Required |
N302 |
"Address2": "Apt 1", |
ShipToAddress.Address2 |
|
Optional |
N401 |
"City": "Yonkers", |
ShipToAddress.City |
|
Required |
N402 |
"State": "NY", |
ShipToAddress.State |
|
Required |
N404 |
"Country": "USA", |
ShipToAddress.Country |
|
Optional |
N403 |
"Zip": "10704", |
ShipToAddress.Zip |
|
Required |
N104 |
"AddressCode": "1234567890", |
ShipToAddress.AddressCode |
Address code that will indicate the location where the address is related to. Codes attached to this page. |
Optional |
|
}, |
|
|
|
|
"ExtendedAttributes": [ |
|
Section will include specific custom information for the trading partner. These can be specific codes; details will be provided on a trading partner basis. The Name will contain the field's label and the value will be the attribute associated with the field. The section will indicate where the value was received and will typically not be used, unless specified. Anything entered in this section will carry over to other linked documents such as the acknowledgement and invoice. |
Optional |
REF02 (DP) |
{ "Name": "DepartmentNumber", "Value": "12345" }, |
ExtendedAttribute.DepartmentNumber |
Sears department number |
Optional |
REF02 (19) |
{ "Name": "DivisionNumber", "Value": "555444" }, |
ExtendedAttribute.DivisionNumber |
Division in which is ordering the product |
Optional |
REF02 (DP) |
{ "Name": "CarrierReference", "Value": "12345" }, |
ExtendedAttribute.CarrierReference |
Will be used on the UPS label in the "Ref:" field. |
Required |
CSH01 |
{ "Name": "SalesRequirement", "Value": "P2" }, |
SalesRequirement |
Indicates the terms of completing the purchase order. Applicable codes are listed below: P2 = Ship ASAP |
Optional |
|
], |
|
|
|
|
"OrderLines": [ { |
|
|
|
PID05 (08) |
"Description": "BLOUSE", |
OrderLine.Description |
Standard short description or name of the product. |
Optional |
PO101 |
"LineNumber": 1, |
OrderLine.LineNumber |
Purchase order line number. |
Required |
PO104 |
"Price": 31.02, |
OrderLine.Price |
Unit cost that the merchant expects to be billed for each unit fulfilled. Sears does not include this information on the order. |
Optional |
PO102 |
"Quantity": 5, |
OrderLine.Quantity |
Contains the quantity of items to be fulfilled. |
Required |
PO103 |
"QuantityUOM": "EA", |
OrderLine.QuantityUOM |
Unit of Measure for the quantity ordered. See partner's details for specifics. |
Required |
|
"ItemIdentifier": { |
|
|
|
PO107, PO109, PO111 (SK) |
"PartnerSKU": "T1-1234150042CWO", |
OrderLine.ItemIdentifier.PartnerSKU |
The Item identifier that is internal to the purchaser/merchant. |
Optional |
PO107, PO109, PO111 (VN) |
"SupplierSKU": "T1-1234", |
OrderLine.ItemIdentifier.SupplierSKU |
The Item Identifier that is used by the supplier or the person fulfilling the product. |
Required |
|
}, |
|
|
|
|
"Discounts": [ { |
|
|
|
|
} ], |
|
|
|
|
"ShipmentInfos": [ { |
|
|
|
|
} ], |
|
|
|
|
"Taxes": [ { |
|
|
|
|
} ], |
|
|
|
|
"ExtendedAttributes": [ |
|
Section will provide custom item information.These can be specific codes; details will be provided on a trading partner basis. The Name will contain the field's label and the value will be the attribute associated with the field. The section will indicate where the value was received and will typically not be used, unless specified. |
Optional |
REF02 (PL) |
{ "Name": "PLS_Number", "Value": "1" }, |
OrderLine.ExtendedAttribute.PLS_Number |
Price List Number |
Optional |
REF02 (MR) |
{ "Name": "MR_Code", "Value": "1" }, |
OrderLine.ExtendedAttribute.MR_Code |
Sears Order Type. If RPC3 or RPC4 the order line must be shipped complete, cannot ship the line partially. RPC1 or RPC2 can allow partial shipments. |
Optional |
REF02 (CR) |
{ "Name": "CUSTNAME", "Value": "1" }, |
OrderLine.ExtendedAttribute.CUSTNAME |
Short name identifier for the customer. |
Optional |
|
] } ] |
|
|
|
|
} |
|
|
|
Comments
0 comments
Article is closed for comments.