API Order, Ack, Shipment, Invoice
Order
| Logicbroker Field | Description | Requirement |
|---|---|---|
| Identifier.SourceKey | Identifier from the source system (usually matches PartnerPO) | Read Only |
| Identifier.LogicbrokerKey | Logicbroker document ID, used to prevent duplicates | Read Only |
| Identifier.LinkKey | Key to link document to original order/shipment | Read Only |
| SenderCompanyId | Logicbroker Company ID of sender | Required |
| ReceiverCompanyId | Logicbroker Company ID of receiver | Required |
| DocumentDate | Date document was created in Logicbroker | Required |
| OrderDate | Date of the Purchase Order | Required |
| OrderNumber | End customer’s order number (packing slip reference) | Required |
| PartnerPO | Purchase order number (primary reference) | Required |
| VendorNumber | Vendor number provided by merchant | Optional |
| TypeCode | Order type code (DS = Drop Ship, SA = Standalone, RE = Reorder) | Optional |
| StatusCode | Status of document in Logicbroker | Optional |
| TotalAmount | Order total | Optional |
| HandlingAmount | This will be the total amount of Handling Amount plus Shipping Amounts. Please note, use the broken out fields instead of this field. | Optional |
| DropshipAmount | Not used. | Not used |
| Note | Order-level notes or messages | Optional |
| ShipmentInfo.ClassCode | Shipment method sent by ITA Group | Required |
| Tax.TaxAmount | Total tax amount | Optional |
| ExtendedAttribute.ProgramID | Program identifier | Optional |
| ExtendedAttribute.StorefrontID | Storefront identifier | Optional |
| ExtendedAttribute.ClientID | Client identifier | Optional |
| ExtendedAttribute.CustomerShipping | End-customer shipping amount | Optional |
| ExtendedAttribute.CustomerHandling | End-customer handling amount | Optional |
| ExtendedAttribute.Shipping Amount | This is the end-customer shipping amount. This is an important field that you would need to send back on the invoice if you were to update the amount. | Required |
| ExtendedAttribute.Handling Amount | This is the end-customer handling amount. This is an important field that you would need to send back on the invoice if you were to update the amount. | Required |
| ExtendedAttribute.SourceSystem | Source of order (e.g., API, Portal) | Optional |
| ExtendedAttribute.LinkKey | Reference back to order document | Read Only |
| ExtendedAttribute.Key | Internal GUID | Read Only |
| ShipToAddress.CompanyName | Ship-to company | Required |
| ShipToAddress.FirstName | Ship-to first name | Optional |
| ShipToAddress.LastName | Ship-to last name | Optional |
| ShipToAddress.Address1 | Ship-to street address | Required |
| ShipToAddress.Address2 | Ship-to street address 2 | Optional |
| ShipToAddress.City | Ship-to city | Required |
| ShipToAddress.State | Ship-to state | Required |
| ShipToAddress.Zip | Ship-to postal code | Required |
| ShipToAddress.Country | Ship-to country | Optional |
| ShipToAddress.Phone | Ship-to phone number | Optional |
| ShipToAddress.Email | Ship-to email | Optional |
| BillToAddress.CompanyName | Bill-to company | Required |
| BillToAddress.FirstName | Bill-to first name | Optional |
| BillToAddress.LastName | Bill-to last name | Optional |
| BillToAddress.Address1 | Bill-to street address | Required |
| BillToAddress.Address2 | Bill-to street address 2 | Optional |
| BillToAddress.City | Bill-to city | Required |
| BillToAddress.State | Bill-to state | Required |
| BillToAddress.Zip | Bill-to postal code | Required |
| BillToAddress.Country | Bill-to country | Optional |
| OrderLine.LineNumber | Line item number | Required |
| OrderLine.ItemIdentifier.SupplierSKU | Supplier SKU | Required |
| OrderLine.ItemIdentifier.PartnerSKU | Partner SKU | Optional |
| OrderLine.Description | Product description | Optional |
| OrderLine.Quantity | Quantity ordered | Required |
| OrderLine.Price | Unit cost | Optional |
| OrderLine.RetailPrice | Retail price | Optional |
| OrderLine.MSRP | MSRP | Optional |
| OrderLine.Weight | Line weight | Optional |
| OrderLine.IsDropShip | Drop ship flag | Optional |
Acknowledgement
| Logicbroker Field | Description | Requirement |
|---|---|---|
| Identifier.SourceKey | Identifier that will come from the source system; typically this will match the PartnerPO. | Read Only |
| Identifier.LogicbrokerKey | ID to identify the document in the logicbroker system. | Read Only |
| Identifier.LinkKey | 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. | Read Only |
| SenderCompanyId | Logicbroker Internal Company ID to specify what company is sending the document. | Required |
| ReceiverCompanyId | Logicbroker Internal Company ID to specify what company is to receive the document. | Required |
| Type |
Indicates how the acknowledgement will be treated. 0 = AcknowledgeWithChange 1 = Acknowledge 2 = Reject |
Optional - if not sent the type of acknowledgement will be determined by the Quantites accepted, cancelled, or backordered on the line level. |
| OrderNumber | Contains the end customer's order number, this will be used on the packing slip. | Will pull from Order |
| 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 |
| OrderDate | Date on the Purchase Order | Optional - will be pulled from original order if not provided |
| AcknowledgementNumber | Unique Identifier used to identify the acknowledgment | Required |
| ScheduledShipDate | Used to identify the date the items listed on the acknowledgement will ship. | Required |
| DocumentDate | Date of the Acknoweldgement. This field will automatically default with the date the document is created. | Read Only |
| ExtendedAttribute.EXAMPLE | Optional | |
| AckLines.ItemIdentifier.PartnerSKU | The Item identifier that is internal to the purchaser/merchant. | Conditional - if received on an order this value should be returned |
| 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 |
| AckLines.ItemIdentifier.UPC | 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. | Conditional - if received on an order this value should be returned |
| AckLines.Price | Unit cost that the merchant expects to be billed for each unit fulfilled. | Optional - only necessary to be provided if there is a change from the order |
| AckLines.PriceCode | Used to indicate the price level for the product. See specific partner details for applicable codes. | Optional - only necessary to be provided if there is a change from the order |
| AckLines.LineNumber | Purchase order line number. | Conditional - if received on an order this value should be returned |
| AckLines.Quantity | 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. | Conditional - Required if Accepting items |
| AckLines.QuantityCancelled | If this value is provided, Qty will get automatically updated and the change reason will get updated appropriately. | Conditional - Required if Cancelling items |
| AckLines.QuantityBackordered | If this value is provided, Qty will get automatically updated and the change reason will get updated appropriately. | Conditional - Required if Backordering items |
| 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 |
| AckLines.ChangeReason |
Free Form Reason for cancellation, or acceptance of line item. For certain partners this may require a specific code; the standard codes are listed below. Administrative request |
Conditional - Required if Cancelling items |
Shipment
| Logicbroker Field | Description | Requirement |
|---|---|---|
| Identifier.SourceKey | Identifier that will come from the source system; typically this will match the PartnerPO. | Read Only |
| Identifier.LogicbrokerKey | ID to identify the document in the logicbroker system. | Read Only |
| Identifier.LinkKey | 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 | Logicbroker Internal Company ID to specify what company is sending the document. | Required |
| ReceiverCompanyId | Logicbroker Internal Company ID to specify what company is to receive the document. | Required |
| ShipmentNumber | Unique ID to identify the shipment. | Required |
| ShipmentDate | Date units are shipped | Required |
| DocumentDate | Date the document was created. This field will automatically default with the date the document is created. | Required |
| 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 |
| OrderDate | Date on the Purchase Order | Optional - will be pulled from original order if not provided |
| OrderNumber | Contains the end customer's order number, this will be used on the packing slip. | Optional |
| BillofLading | Document number issued by the carrier which contains details of the shipment. | Conditional - if available |
| PRONumber | Typically used by LTL freight carriers, A PRO number is a series of numbers used by carriers as a reference for freight movement; this is like a tracking number. | Conditional - if available |
| VendorNumber | This is the internal vendor number provided to the supplier from the merchant. If available it is always recommended to send. | Optional |
| Note | Notes or shipping instructions provided by supplier; see the meaning of the notes on the individual partners notes. | Optional |
| ExpectedDeliveryDate | Date the shipment is expected to be received at the shipping location. | Required |
| Payments.Method |
Shipment method of payment. Typical codes received are listed below: CC: Collect PO: Prepaid Only |
Optional |
| ShipFromAddress.CompanyName | ShipFromAddress is not required if you have a rule in place to default for all shipments. | Required |
| ShipFromAddress.FirstName | Required | |
| ShipFromAddress.LastName | Optional | |
| ShipFromAddress.Address1 | Required | |
| ShipFromAddress.Address2 | Required | |
| ShipFromAddress.City | Required | |
| ShipFromAddress.State | Required | |
| ShipFromAddress.Country | Optional | |
| ShipFromAddress.Zip | Required | |
| ShipFromAddress.AddressCode | Optional | |
| ShipFromAddress.Phone | Optional | |
| ShipFromAddress.Email | Optional | |
| ShipmentInfo.ContainerCode | SSCC-18 and Application Identifier to be used to identify the pallet. If not provided the tracking number can be used. To identify what cartons belong to the pallet, you will need to enter this value in the "ParentContainerCode" under the "ShipmentInfos" (containers) on the line level. | Conditional - only required if sending a pallet |
| ShipmentInfo.ContainerType | Use "PLT" to Specify Pallet | Conditional - only required if sending a pallet |
| ShipmentInfo.TrackingNumber | Conditional - only required if sending a pallet | |
| ShipmentInfo.Weight | Total gross weight of the package or carton. | Conditional - only required if sending a pallet |
| ShipmentInfo.WeightUnit | Weight Unit of Measure for the package or carton. | Conditional - only required if sending a pallet |
| ShipmentInfo.Length | Length of the container or package. | Conditional - only required if sending a pallet |
| ShipmentInfo.Width | Width of the container or package. | Conditional - only required if sending a pallet |
| ShipmentInfo.Height | Height of the container or package. Should be provided in inches. | Conditional - only required if sending a pallet |
| ShipmentInfo.DimensionUnit | Dimension unit of measure used for Length, Height and Width. | Conditional - only required if sending a pallet |
| ExtendedAttribute.EXAMPLE | ||
| ShipmentLine.Description | Standard short description or name of the product. | Optional |
| ShipmentLine.Quantity | Will be copied from the QTY Shipped provided under Shipment Infos. | Read Only |
| ShipmentLine.LineNumber | Line Number from the Order. If not provided this will be taked from the order automatically. | Required |
| ShipmentLine.QuantityUOM | Unit of measure to identify the quantity in the container or package. | Required |
| ShipmentLine.Price | Unit cost that the merchant expects to be billed for each unit fulfilled. | Optional |
| ShipmentLine.ItemIdentifier.PartnerSKU | The Item identifier that is internal to the purchaser/merchant. | Conditional - if received on an order this value should be returned |
| ShipmentLine.ItemIdentifier.ManufacturerSKU | Manufacturer's ID for the product. | Conditional - if received on an order this value should be returned |
| ShipmentLine.ItemIdentifier.ISBN | International Standard Book Number | Conditional - if received on an order this value should be returned |
| ShipmentLine.ItemIdentifier.SupplierSKU | The Item Identifier that is used by the supplier or the person fulfilling the product. This will always contain a value. | Required |
| ShipmentLine.ItemIdentifier.UPC | 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. | Conditional - if received on an order this value should be returned |
| ShipmentLine.ShipmentInfo.DateShipped | Date the package was shipped. This will updated all header DateShipped values. | Required |
| ShipmentLine.ShipmentInfo.ContainerCode | SSCC-18 and Application Identifier to be used to identify the child container. Field is required, hoewever if no value is provided the tracking number will be used as the container code. | Conditional - Only required if partner requires GS1-128 |
| ShipmentLine.ShipmentInfo.Qty | Total Qty of the product within the package or container. This quantity will be summed up across all containers and the total will be supplied on the item level "Quantity" field. | Required |
| ShipmentLine.ShipmentInfo.TrackingNumber | Tracking number Identifier provided from the carrier to be used to identify the container. If no container code is being used, this will be used as the container code. | Required |
| ShipmentLine.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 |
| ShipmentLine.ShipmentInfo.ClassCode | The shipping method that will be used to send the merchandise. This can be a free form field or if using the shipment code mappings will need to match the Custom Code that was setup. When sending the Custom Code, the corresponding CarrierCode and Class Code will automatically get populated. | Required |
| ShipmentLine.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 ON = Overnight SA = Same Day If you are using your own custom shipping methods to map "ServiceLevelCode" then you will not need to provide the value, however the proper mapped code will need to be provided in the ClassCode. |
Optional |
| ShipmentLine.ShipmentInfo.ShipmentContainerParentCode | SSCC-18 and Application Identifier to be used to identify the pallet. If you are shipping a pallet and need to identify which cartons belong to it, this value needs to match the container code provided on the pallet in the header level "ShipmentInfo" | Optional |
| ShipmentLine.ShipmentInfo.ContainerType | Specifies the code used to identify the package type. See specific trading partner for correct codes. "0" will indicate what number pallet is being used. Numbers will start at 0, and increment by 1. | Required |
| ShipmentLine.ShipmentInfo.Weight | Total weight of the package or carton. Default will be in pounds. | Required |
| ShipmentLine.ShipmentInfo.WeightUnit | Weight Unit of Measure for the package or carton. Default will be in pounds. | Optional |
| ShipmentLine.ShipmentInfo.Length | Length of the container or package. To be provided in inches. | Required |
| ShipmentLine.ShipmentInfo.Width | Width of the container or package. To be provided in inches. | Required |
| ShipmentLine.ShipmentInfo.Height | Height of the container or package. To be provided in inches. | Required |
| ShipmentLine.ShipmentInfo.DimensionUnit | Dimension for the values in Length, Width and Height fields. | Optional |
Invoice
| Logicbroker Field | Description | Requirement |
|---|---|---|
| Identifier.SourceKey | Identifier from the source system (usually matches invoice/order ref) | Read Only |
| Identifier.LogicbrokerKey | Logicbroker document ID | Read Only |
| Identifier.LinkKey | Key to link the invoice back to the order | Read Only |
| SenderCompanyId | Logicbroker Company ID of sender | Required |
| ReceiverCompanyId | Logicbroker Company ID of receiver | Required |
| DocumentDate | Date the document was created in Logicbroker | Required |
| InvoiceNumber | Supplier’s invoice number | Required |
| InvoiceDate | Invoice date | Required |
| InvoiceTotal | Total invoice amount (Quantity × Price + Shipping + Handling + Tax – Discounts) | Required |
| TotalAmount | Sum of line + charges (redundant with InvoiceTotal, but included for validation) | Optional |
| HandlingAmount | Handling charge applied | Optional |
| DropshipAmount | Drop ship charge applied | Optional |
| Note | Notes (ProgramID, StorefrontID, ClientID, messages) | Optional |
| PartnerPO | Purchase Order number the invoice is for | Required |
| OrderDate | Original order date | Optional |
| VendorNumber | Supplier/vendor number provided by merchant | Optional |
| StatusCode | Status of document in Logicbroker | Optional |
| PaymentTerm.TermsDescription | Description of payment terms | Optional |
| PaymentTerm.PayInNumberOfDays | Net days for payment | Required |
| PaymentTerm.DiscountInNumberOfDays | Days discount valid | Optional |
| PaymentTerm.AvailableDiscount | Discount amount available | Optional |
| PaymentTerm.DiscountPercent | Discount percent available | Optional |
| PaymentTerm.DueDate | Invoice due date | Optional |
| PaymentTerm.DiscountDueDate | Date discount expires | Optional |
| PaymentTerm.EffectiveDate | Date terms effective | Optional |
| ExtendedAttribute.Shipping Amount | Shipping cost (must match order within tolerance) | Required |
| ExtendedAttribute.Handling Amount | Handling cost (must match order within tolerance) | Required |
| ExtendedAttribute.Credit Memo? | Indicates credit memo if present | Optional |
| ExtendedAttribute.OrderLogicbrokerKey | Links invoice to Logicbroker order | Required |
| InvoiceLine.LineNumber | Invoice line number | Required |
| InvoiceLine.Quantity | Invoiced quantity | Required |
| InvoiceLine.Price | Unit invoice price | Required |
| InvoiceLine.RetailPrice | Retail unit price | Optional |
| InvoiceLine.Cost | Unit cost | Optional |
| InvoiceLine.MSRP | MSRP | Optional |
| InvoiceLine.Weight | Weight per unit | Optional |
| InvoiceLine.IsDropShip | Drop ship flag | Optional |
| InvoiceLine.ItemIdentifier.SupplierSKU | Supplier SKU | Required |
| InvoiceLine.ItemIdentifier.PartnerSKU | Partner SKU | Optional |
| InvoiceLine.Discounts.DiscountPercent | Item discount percent | Optional |
| InvoiceLine.Discounts.DiscountAmount | Item discount amount | Optional |
| InvoiceLine.Taxes.TaxAmount | Item tax | Optional |
| InvoiceLine.ExtendedAttribute.PartnerLineID | Links invoice line to PO line | Required |
| 🔗Sample Order.txt
3 KB Download
|