All data formats for all integrations are provided below. XML structure will be the same as JSON.
IMPORTANT: Sears Home Services has four order types, and there are different shipping rules depending on those order types. Make sure you understand the different and requirements of those rules here: https://sears.logicbroker.com/hc/en-us/articles/360000145186-What-are-the-shipping-rules-for-the-various-order-types-How-can-I-tell-
For actual samples see these articles:
EDI Field |
JSON |
CSV Field Name |
Description |
User Requirement |
|
{ |
|
|
|
|
"Identifier": { |
|
|
|
|
"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 invoice. 0 (New) = All documents start at New and will quickly move to submitted. 100 (New) = 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). Will move to next status 200 automatically. 200 (Processing) = In this status the original order Quantity invoiced will get updated and update the original order status to reflect an invoice was received against it. Once the invoice is process against the order, if the entire order has been shipped, the order status will move to 1000 (Complete). 1000 (Complete) = indicates the document has been successfully been sent to the receiver and linked to an existing order. 1100 (Cancelled) = indicates the shipment 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 |
BIG01 |
"InvoiceDate": "2015-11-05T16:23:30.978Z", |
InvoiceDate |
Date of the invoice. |
Required |
BIG02 |
"InvoiceNumber": "INV100012345", |
InvoiceNumber |
Number to identify the unique invoice document. |
Required |
N/A |
"DocumentDate": "2015-11-05T16:23:30.978Z", |
|
Date the document was created. This field will automatically default with the date the document is created. |
Required |
BIG03 |
"OrderDate": "2015-11-05T16:23:30.978Z", |
OrderDate |
Date on the Purchase Order |
Optional - will be pulled from original order if not provided |
BIG04 |
"PartnerPO": "PO1000100123456", |
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 |
SAC05_C (G821) |
"HandlingAmount": 4.00, |
HandlingAmount |
Shipping and handling total to be charged on the invoice, this is part of the invoice total. |
Optional |
TDS01 |
"InvoiceTotal": 5.00, |
InvoiceTotal |
Invoice total includes, full amount to be paid including line totals and shipping. Will be automatically calculated if no value is provided. |
Required |
|
"Discounts": [ { |
|
|
|
|
} ], |
|
|
|
|
"Taxes": [ { |
|
|
|
|
} ], |
|
|
|
|
"PaymentTerm": { |
|
|
|
|
}, |
|
|
|
|
"RemitToAddress": { |
|
Address whom the payment will get sent to |
Required |
|
}, |
|
|
|
|
"ShipToAddress": { |
|
Address where the items will be shipped |
Optional |
|
}, |
|
|
|
|
"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 |
|
}, |
|
|
|
|
"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 |
|
], |
|
|
|
|
"InvoiceLines": [ { |
|
|
Required |
IT101 |
"LineNumber": "1", |
InvoiceLine.LineNumber |
Line Number from the Order. If not provided this will be taken from the order automatically. |
Required |
IT104 |
"Price": 90.99, |
InvoiceLine.Price |
Unit cost that the merchant is being billed for that line. |
Required |
IT102 |
"Quantity": 14, |
InvoiceLine.Quantity |
Contains the quantity of items to be invoiced. |
Required |
IT103 |
"QuantityUOM": "EA", |
InvoiceLine.QuantityUOM |
Unit of Measure for the quantity invoiced. See partner's details for specifics. |
Required |
|
"ItemIdentifier": { |
|
|
|
IT107, IT109, IT111 |
"PartnerSKU": "T1-1234150042CWO", |
InvoiceLine.ItemIdentifier.PartnerSKU |
The Item identifier that is internal to the purchaser/merchant. |
Conditional - if received on an order this value should be returned |
IT107, IT109, IT111 |
"SupplierSKU": "T1-1234", |
InvoiceLine.ItemIdentifier.SupplierSKU |
The Item Identifier that is used by the supplier or the person fulfilling the product. This will always contain a value. |
Required |
|
"ShipmentInfos": [ { |
|
At least one carton is required on the shipment. The carton under the line item indicates that the product is in this container. If the product belongs to multiple containers, then muliple ShipmentInfo loops will need to be created under the line. |
Required |
IT1:CAD08 |
"TrackingNumber": "TRK11111", |
InvoiceLine.ShipmentInfo.TrackingNumber |
Tracking number Identifier provided from the carrier to be used to track the shipment. NOTE: If LTL is the carrier code, tracking number should reflect the PRO# and provider. Example: 14530045948 CTII |
Required |
IT1:CAD04 |
"CarrierCode": "FEDG1", |
InvoiceLine.ShipmentInfo.CarrierCode |
This will typically be the Standard Carrier Alpha Code (SCAC). If you are using your own custom shipping methods to map "CarrierCode" and "ServiceLevelCode" then this will not be required, however the proper mapped code will need to be provided in the ClassCode. |
Required |
DTM02 (011) |
"DateShipped": "0001-01-01T00:00:00", |
InvoiceLine.ShipmentInfo.DateShipped |
Date the package was shipped. This will updated all header DateShipped values. |
Required |
|
}, ], |
|
|
|
|
}, |
|
|
|
|
"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 |
SAC01,SAC02 (ZZZZ), SAC05 |
{ |
InvoiceLine.ExtendedAttribute.CORE_Charge |
Will only be used if you are sending the CORE charge associated with the item. This value should not be included in the total item price that is provided in the IT104 Price field. CORE charge is a subset of the total item price. |
Optional |
IT107, IT109, IT111 |
{ "Name": "SubstitutePartNumber", "Value": "1" }, |
InvoiceLine.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.