Skip to content
  • There are no suggestions because the search field is empty.

Acknowledgement Specification

PLACEHOLDER DATA - NOT REVIEWED OR APPROVED

*API field name refers to field names for XML, JSON, and CSV field names.

EDI Field Logicbroker/API Field Description Requirement

N/A

Identifier.SourceKey

Identifier that will come from the source system; typically this will match the PartnerPO.

Read Only

N/A

Identifier.LogicbrokerKey

ID to identify the document in the logicbroker system.

Read Only

N/A

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

N/A

SenderCompanyId

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

Required

N/A

ReceiverCompanyId

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

Required

BAK02

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 Quantities accepted, cancelled, or backordered on the line level.

N/A

OrderNumber

Contains the end customer's order number, this will be used on the packing slip.

Will pull from Order

BAK03

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

BAK09

OrderDate

Date on the Purchase Order

Optional - will be pulled from original order if not provided

BAK08

AcknowledgementNumber

Unique Identifier used to identify the acknowledgment

Required

N/A

VendorNumber

This is the internal vendor number provided to the supplier from the merchant. If available it is always recommended to send.

Optional

N/A

ChangeReason

Free form text for reason of cancellation or acceptance. For certain partners this may require a specific code.

Conditional

PO1:ACK:DTM02 (068)

ScheduledShipDate

Used to identify the date the items listed on the acknowledgement will ship.

Conditional - required if backordering items

BAK04

DocumentDate

Date of the Acknowledgement. This field will automatically default with the date the document is created.

Read Only

N102 (ST)

ShipToAddress.CompanyName

 

Optional

N201 (ST)

ShipToAddress.FirstName

 

Optional

N202 (ST)

ShipToAddress.LastName

 

Optional

N301 (ST)

ShipToAddress.Address1

 

Optional

N302 (ST)

ShipToAddress.Address2

 

Optional

N401 (ST)

ShipToAddress.City

 

Optional

N402 (ST)

ShipToAddress.State

 

Optional

N404 (ST)

ShipToAddress.Country

 

Optional

N403 (ST)

ShipToAddress.Zip

 

Optional

N104 (ST*92)

ShipToAddress.AddressCode

 

Optional

N1:PER06 (TE)

ShipToAddress.Phone

 

Optional

N1:PER04 (EM)

ShipToAddress.Email

 

Optional

N102 (BT)

BillToAddress.CompanyName

 

Optional

N201 (BT)

BillToAddress.FirstName

 

Optional

N202 (BT)

BillToAddress.LastName

 

Optional

N301 (BT)

BillToAddress.Address1

 

Optional

N302 (BT)

BillToAddress.Address2

 

Optional

N401 (BT)

BillToAddress.City

 

Optional

N402 (BT)

BillToAddress.State

 

Optional

N404 (BT)

BillToAddress.Country

 

Optional

N403 (BT)

BillToAddress.Zip

 

Optional

N104 (BT*92)

BillToAddress.AddressCode

 

Optional

N1:PER06 (TE)

BillToAddress.Phone

 

Optional

N1:PER04 (EM)

BillToAddress.Email

 

Optional

N/A

ExtendedAttribute.EXAMPLE

 

Optional

PO1:PO109 (IN)

AckLines.ItemIdentifier.PartnerSKU

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

Conditional - if received on an order this value should be returned

N/A

AckLines.ItemIdentifier.ManufacturerSKU

Manufacturer's ID for the product.

Conditional - if received on an order this value should be returned

PO1:PO107 (VN)

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

PO1:PO111 (UP)

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

PO1:PO104

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

N/A

AckLines.RetailPrice

Unit Price to be charged to the customer or end receiver. This will typically be the value on the packing slip.

Optional

PO1:PO105

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

PO1:PO101

AckLines.LineNumber

Purchase order line number.

Conditional - if received on an order this value should be returned

PO1:ACK02 (IA)

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

PO1:ACK02 (IR)

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

PO1:ACK02 (IB)

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

PO1:ACK03

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

PO1:N902 (TD)

AckLines.ChangeReason

Free Form Reason for cancellation, or acceptance of line item.

Cancellation Codes:

Conditional - Required if cancelling items

PO1: PID05 (35)

AckLines.ExtendedAttribute.Color

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

Optional - only necessary to be provided if there is a change from the order

PO1: PID05 (91)

AckLines.ExtendedAttribute.Size

Size identifier for the product.

Optional - only necessary to be provided if there is a change from the order

 

History:

3/14/19 - Original specification created