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": { |
|
|
Required - one identifier is required |
|
"SourceKey": "string", |
|
Identifier that will come from the source system; typically this will match the PartnerPO. |
Read Only |
|
"LogicbrokerKey": "string", |
|
ID to identify the document in the logicbroker system. |
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 |
|
}, |
|
|
|
|
"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 acknowledgement. 0 (New) = All documents start at New and will quickly move to submitted. 100 (Submitted) = will be defaulted to this status when first created. The document will only remain in this status briefly as it is processing (getting sent to receiver). 200 (Processing) = Acknowledgement is updating original order and will automatically move to 1000 (Complete). 1000 (Complete) = indicates the document has been successfully been sent to the receiver. 1100 (Cancelled) = indicates the acknowledgement has been cancelled. Refer to the document history to ensure the document was not sent; if it has the receiving party should be notified. 1200 (Failed) = The status will indicate there was an error processing the document. 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 document to see the reason for the failure |
Read Only |
|
"OrderNumber": "002152252", |
|
Contains the end customer's order number, this will be used on the packing slip. |
Optional |
BAK03 |
"PartnerPO": "1599999999", |
PartnerPO |
This will be the purchase order number, this will be the main Key to link all your documents. This should match the order. |
Required |
BAK04 |
"OrderDate": "2015-11-13T18:34:52.411Z", |
OrderDate |
Date on the Purchase Order |
Optional - will be pulled from original order if not provided |
BAK08 |
"AcknowledgementNumber": "ACK5566", |
AcknowledgementNumber |
Unique Identifier used to identify the acknowledgment |
Required |
PO1:ACK05 (068) |
"ScheduledShipDate": "2016-02-15T19:32:00.069Z", |
|
Used to identify the date the items listed on the acknowledgement will ship. Required if items are backordered. |
Conditional |
BAK09 |
"DocumentDate": "2016-02-15T19:32:00.070Z", |
Date of the Acknoweldgement. This field will automatically default with the date the document is created. |
Required |
|
|
"ShipToAddress": { |
|
Address where the order will be shipped. Typically if this is being sent in an Acknowledgement this indicates there was a change or adjustment to the address |
Optional |
|
}, |
|
|
|
|
"BillToAddress": { |
|
Address for whom the order will be billed and require payment from. Typically if this is being sent in an Acknowledgement this indicates there was a change or adjustment to the address |
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. This section will also include any extended attributes created on the linked order; these carry over from the order. |
Optional |
|
], |
|
|
|
|
"AckLines": [ { |
|
Note that if you are accepting, cancelling or backordering an item, you will need to do it for the entire line. Partial acceptance, cancellation will not be processed. |
Required - at least one line is required |
|
"ItemIdentifier": { |
|
|
Required - at least one identifier is required |
PO107, PO109, PO111 |
"PartnerSKU": "T1-1234150042CWO", |
AckLines.ItemIdentifier.PartnerSKU |
The Item identifier that is internal to the purchaser/merchant. |
Conditional - if received on an order this value should be returned |
PO107, PO109, PO111 |
"SupplierSKU": "T1-1234", |
AckLines.ItemIdentifier.SupplierSKU |
The Item Identifier that is used by the supplier or the person fulfilling the product. This will always contain a value. |
Required |
|
}, |
|
|
|
PO101 |
"LineNumber": 1, |
AckLines.LineNumber |
Purchase order line number. |
Required |
ACK02 (IA) |
"Quantity": 2, |
AckLines.Quantity |
Used to list the quantity being acknowledged for this product. **NOTE if an item line is being Accepted, Backordered, or Cancelled, the entire line quantity will need to be accepted, backordered or cancelled. |
Conditional - Required if Accepting items |
ACK02 (IR) |
"QuantityCancelled": 0, |
AckLines.QuantityCancelled |
There are 2 types of cancellations, one for standard cancellations and one for when the part is unavailable or discontinued. Refer to the ChangeReason field when identifying that the product is discontinued. **NOTE if an item line is being Accepted, Backordered, or Cancelled, the entire line quantity will need to be accepted, backordered or cancelled. |
Conditional - Required if Cancelling items |
ACK02 (IB) |
"QuantityBackordered": 0, |
AckLines.QuantityBackordered |
Quantity that will not be fulfilled in the next 24 hours. **NOTE if an item line is being Accepted, Backordered, or Cancelled, the entire line quantity will need to be accepted, backordered or cancelled. |
Conditional - Required if Backordering items |
ACK03 |
"QuantityUOM": "EA", |
AckLines.QuantityUOM |
Unit of Measure for the Quantity being identified for this line. |
Optional - only necessary to be provided if there is a change from the order |
N903 (TD) |
"ChangeReason": "ItemLevelChange", |
AckLines.ChangeReason |
If a part is discontinued and will not be used again in the future, use the code QP here for the line when cancelling. |
Conditional |
|
"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 |
ACK04 (068) |
{ "Name": "ExpectedShipDate", "Value": "2017-08-25" }, |
AckLines.ExtendedAttribute.ExpectedShipDate |
Will only be used if "Quantity" accepted or "QuantityBackordered" has a value |
Conditional |
PO107, PO109, PO111 |
{ "Name": "SubstitutePartNumber", "Value": "1" }, |
AckLines.ExtendedAttribute.SubstitutePartNumber |
Will only be used if you are sending a different part number then what was originally on the order. If you do use a subsitute part number, you will still need to send the "SupplierSKU" and "PartnerSKU" as received on the original order. |
Optional |
|
] } ] |
|
|
|
|
} |
|
|
|
Comments
0 comments
Article is closed for comments.