Order

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",

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,

Logicbroker Internal Company ID to specify what company is sending the document.

Required

"ReceiverCompanyId": 0,

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.

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).

600 (Ready to Invoice) = Status indicates order is pending invoicing. Once the invoice is received and all item Quantities have been shipped the status will move to complete.

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

"DocumentDate": "2016-04-22T20:45:22.79",

Date the document was created in the logicbroker system.

Required

"Currency": "USD",

Currency Code used on the purchase order.

Optional

"CustomerNumber": "444",

End User's customer ID; typically used on the packing slip

Optional

"DoNotShipAfter": "2015-11-07T20:51:56.728Z",

Date in which the PO should be cancelled if the date has been passed before shipment.

Optional

"HandlingAmount": 15,

Shipping amount to be applied and included in the order total.

Optional

"Note": "Get well soon!",

This section will include gift and packing slip messages.

Optional

"OrderDate": "2013-10-31",

Date on the Purchase Order

Required

"OrderNumber": "002152252",

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

"TypeCode": "SA",

Purchase Order Type Code will indicate what type of PO is being sent. Examples are shown below.

SA = Stand Alone

RE = Re-Order

DS = Drop Ship

Optional

"ReleaseNumber": "001",

Used for replacement orders to not duplicate the fulfillment of the same PO.

Optional

"RequestedShipDate": "2015-11-06",

Date requested for order to leave the warehouse/shipping location.

Optional

"SalesRequirement": "0",

Indicates the terms of completing the purchase order. Applicable codes are listed below:

0 = NoBackorder

1 = Backorder if out of stock

2 = ShipComplete

Optional

"VendorNumber": "V12345",

This is the internal vendor number provided to the supplier from the merchant

Optional

"Discounts": [

{

"DiscountAmount": 5,

Discount amount to be applied and included in the order total.

Optional

"DiscountCode": "0001883",

Promotional/Deal Number or Code

Optional

"DiscountPercent": 0

Terms Discount Percent to calculate applicable discount amount for timely payment

Optional

}

],

"PaymentTerm": {

"DiscountAvailable": 55,

Terms discount amount that will be applied within timely payment.

Optional

"DiscountDueDate": "0001-01-01",

Discount due date when discount will be applied.

Optional

"DiscountInNumberOfDays": 10,

Discount days due when discount will be applied.

Optional

"EffectiveDate": "2012-01-04",

Date when the Payment terms begin.

Optional

"DueDate": "0001-01-01",

Date in which the invoice is due, before additional charges are accrued.

Optional

"PayInNumberOfDays": 30

Number of days in which the invoice is due, before additional charges are accrued.

Optional

},

"ShipmentInfos": [

{

"CarrierCode": "string",

This will typically be the Standard Carrier Alpha Code (SCAC).

Optional

"ClassCode": "UPSN_CG",

The shipping method that will be used to send the merchandise. This is a free form field and can include UPS Ground, or Overnight, etc.

Required

"ServiceLevelCode": "string"

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

Optional

}

],

"Taxes": [

{

"TaxAmount": 3

Tax Amount to be applied and included in the order total.

Optional

}

],

"BillToAddress": {

Address for whom the order will be billed to.

Optional

"CompanyName": "Merchant Co",

Required

"FirstName": "Jerry",

Optional

"LastName": "Only",

Optional

"Address1": "111 Merchant Lane",

Required

"Address2": "Apt 1",

Optional

"City": "Yonkers",

Required

"State": "NY",

Required

"Country": "USA",

Optional

"Zip": "10704",

Required

"AddressCode": "1234567890",

Address code that will indicate the location where the address is related to. Typically will be a store or DC number.

Optional

"Phone": "111-222-3333",

Optional

"Email": "Merchant@co.com",

Optional

},

"OrderedByAddress": {

This is the bill to address for the end customer. This is typically used for dropship orders.

Optional

"CompanyName": "Merchant Co",

Optional

"FirstName": "Jerry",

Optional

"LastName": "Only",

Optional

"Address1": "111 Merchant Lane",

Optional

"Address2": "Apt 1",

Optional

"City": "Yonkers",

Optional

"State": "NY",

Optional

"Country": "USA",

Optional

"Zip": "10704",

Optional

"AddressCode": "1234567890",

Address code that will indicate the location where the address is related to. Typically will be a store or DC number.

Optional

"Phone": "111-222-3333",

Optional

"Email": "Merchant@co.com",

Optional

},

"ShipToAddress": {

Address where the order will be shipped

Required

"CompanyName": "Merchant Co",

Required

"FirstName": "Jerry",

Optional

"LastName": "Only",

Optional

"Address1": "111 Merchant Lane",

Required

"Address2": "Apt 1",

Optional

"City": "Yonkers",

Required

"State": "NY",

Required

"Country": "USA",

Optional

"Zip": "10704",

Required

"AddressCode": "1234567890",

Address code that will indicate the location where the address is related to. Typically will be a store or DC number.

Optional

"Phone": "111-222-3333",

Optional

"Email": "Merchant@co.com",

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, shipment, and invoice.

Optional

{

"Name": "StoreNumber",

"Value": "12345"

},

Used to identify the store where the order will get shipped for customer pickup. Will also be used to differentiate between D2S and D2C.

Optional

{

"Name": "InternalOrderNumber",

"Value": "ORD555444"

},

This is the internal order number within the merchant's system; typically required on the packing slip.

Optional

{

"Name": "GiftWrap",

"Value": "1"

},

Will be used to indicate gift wrap. "1" will be used to indicate gift wrapping the entire order.

Optional

{

"Name": "MiscCharge",

"Value": "12.12"

},

Charges to be applied to the PO total; format will be XX.XX

Optional

{

"Name": "CustomerDiscount",

"Value": "13.13"

},

Discount amount the end customer received. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "CustomerShipping",

"Value": "5.00"

},

Shipping and Handling amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "CustomerTax",

"Value": "12.95"

},

Tax amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "CustomerMiscCharge",

"Value": "9.99"

},

Miscellaneous charge amount the end customer paid. This can be gift wrapping charge, special services, etc. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "CustomerOrderDate",

"Value": "2016-11-14"

},

Will be used to show date when customer placed order; typically used on the packing slip.

Optional

],

"OrderLines": [

{

"Description": "BLOUSE",

Standard short description or name of the product.

Optional

"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

"Weight": 22,

Weight of the product

Optional

"LineNumber": 01,

Purchase order line number.

Required

"Note": "string",

Specific Notes related to the product. See specific partner for applicable item level messages.

Optional

"Price": 31.02,

Unit cost that the merchant expects to be billed for each unit fulfilled.

Optional

"PriceCode": "WH",

Used to indicate the price level for the product. See specific partner details for applicable codes.

Optional

"Quantity": 5,

Contains the quantity of items to be fulfilled.

Required

"QuantityUOM": "EA",

Unit of Measure for the quantity ordered. See partner's details for specifics.

Required

"ItemIdentifier": {

"ISBN": "string",

International Standard Book Number

Optional

"ManufacturerSKU": "0025252",

Manufacturer's ID for the product.

Optional

"PartnerSKU": "J07874",

The Item identifier that is internal to the purchaser/merchant.

Optional

"SupplierSKU": "49-98760",

The Item Identifier that is used by the supplier or the person fulfilling the product.

Required

"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

},

"Discounts": [

{

"DiscountAmount": 0

Discount amount applied to the corresponding item.

Optional

}

],

"ShipmentInfos": [

{

"CarrierCode": "string",

Used for specific shipping instructions on the line item level. This will typically be the Standard Carrier Alpha Code (SCAC).

Optional

"ClassCode": "UPSN_CG",

Item level shipping method that will be used to send the merchandise. This is a free form field and can include UPS Ground, or Overnight, etc.

Optional

"ShipmentCost": 0,

Shipping amount to be applied to this item.

Optional

"Weight": 0,

Total weight of the package or carton.

Optional

"WeightUnit": "LB"

Weight Unit of Measure for the package or carton.

Optional

}

],

"Taxes": [

{

"TaxAmount": 3.20

Item Level Tax amount

Optional

}

],

"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

{

"Name": "Color",

"Value": "Blue"

},

Color code used to identify specific product attribute. Can also include color description; see specific partner for details.

Optional

{

"Name": "Gift Message",

"Value": "Get well soon!"

},

Item Level Gift Message

Optional

{

"Name": "Item Level Message",

"Value": "MONOGRAM = DAS"

},

Item Level message, to specify additional details for the product. This can include customizations or other instructions.

Optional

{

"Name": "Size",

"Value": "SIZE 15"

},

Size identifier for the product.

Optional

{

"Name": "GiftWrap",

"Value": "1"

},

Will be used to indicate gift wrap. "1" will be used to indicate gift wrapping this specific item.

Optional

{

"Name": "MiscCharge",

"Value": "10.10"

},

Item level charges to be applied to the PO total; format will be XX.XX

Optional

{

"Name": "CustomerDiscount",

"Value": "11.90"

},

Item level discount amount the end customer received. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "CustomerShipping",

"Value": "2.91"

},

Item level shipping and Handling amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "CustomerTax",

"Value": "3.45"

},

Tax amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "CustomerMiscCharge",

"Value": "1.00"

},

Miscellaneous charge amount the end customer paid. This can be gift wrapping charge, special services, etc. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

{

"Name": "SpecialInstructions",

"Value": "Mark as FRAGILE"

},

This would include instruction on packing or shipping this specific item.

Optional

{

"Name": "MiscItemIdentifier",

"Value": "SK000001"

},

This would be an item identifier that does not fit in the standard SupplierSKU, PartnerSKU, or UPC. You would need to refer to the specific trading partner on the usage.

Optional

]

}

]

}