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

Acknowledgement Specification

In Logicbroker the Acknowledgment's purpose is to accept, backorder and cancel items from an order received. Accepting items is typically required to indicate that you are ready to fulfill and ship an order. Backordering an item indicates that you will not ship the item until it is back in stock, this is usually beyond the standard 24 hours shipping window. Last cancelling items indicates that the item will not be fulfilled. All acknowledgements must match the PartnerPO from a previous order otherwise the document will not process.

✨ Tip:

Not all retailers and channels accept the Acknowledgement document and some only use it for accepting, cancelling, backordering, or any combination of the 3. Some may not allow for partial line cancellations or backorders, therefore follow the test cases when onboarding to verify what options are available. Also, if an acknowledgement is received with incorrect or non-compliant data the document will go to a Failed status and no data transmitted to the channel.

When receiving an acknowledgement against and order, it will effect the status of that order. If all quantities on the order are cancelled, the status of the order will automatically update to Cancelled (1100). It is important to note that all acknowledgments must have the PartnerPO and SupplierSKU match the original order otherwise the document will be non-compliant and fail to process.

✨ Tip:

Sending or Receiving an acknowledgement with accepted quantities can be used to update the original order status as well. Typically this will move your order from Ready to Acknowledge (150) to Ready to Ship (500).

🗒️Note:

For Logicbroker customers, if you will be accepting all orders received, we can implement auto-acknowledging for all orders. This will auto create and acknowledgement for every order received for your partners. For more details contact us.

The structure shown below in Field Descriptions follows Logicbroker's standard schema across all document formats; this includes JSON, EDI, XML, CSV, and Portal. The EDI segments are listed next to each field to indicate what field maps to the standard 855 EDI from the Logicbroker schema.

✨ Tip:

If you are integrating via API and need the full model schema see our API Console.

Details and Sample Files
JSON
Download JSON Samples

 

Click the link above to download the samples. All fields listed below reflect the model schema for the Logicbroker standard JSON. For example the snippet below would match the field name ShipToAddress.CompanyName in the Field Descriptions below.

  "ShipToAddress": {
    "CompanyName": "Warehouse 123"
  }

If there is a field that is missing in the structure you can add custom fields as an extended attribute on the header level or item level; see example below. Note when a custom field is added, you will need to notify Logicbroker to ensure it is mapped to your partners.

    "ExtendedAttributes": [
    {
      "Name": "EXAMPLE",
      "Value": "Portal"
    },
    {
      "Name": "EXAMPLE2",
      "Value": "New Value"
    }
  ]

The value in the field descriptions documentation will show as ExtendedAttribute.EXAMPLE and for line items AckLines.ExtendedAttribute.EXAMPLE.

 For Suppliers:

To learn more about how to integrate sending acknowledgements using the JSON format see this link.

 For Retailers:

To learn more about how to integrate receiving acknowledgements from your partners using the JSON format see this link.

XML
Download XML Samples + XSD

 

Click the link above to download the samples and XSD. All fields listed below reflect the model schema for the Logicbroker standard XML. For example the snippet below would match the field name ShipToAddress.CompanyName in the Field Descriptions below.

  <ShipToAddress>
    <CompanyName>Merchant Co</CompanyName>
  </ShipToAddress>

If there is a field that is missing in the structure you can add custom fields as an extended attribute on the header level or item level; see example below. Note when a custom field is added, you will need to notify Logicbroker to ensure it is mapped to your partners.

  <ExtendedAttributes>
    <ExtendedAttribute>
      <Name>Example</Name>
      <Value>Portal</Value>
    </ExtendedAttribute>
    <ExtendedAttribute>
      <Name>Example2</Name>
      <Value>NewValue</Value>
    </ExtendedAttribute>
  </ExtendedAttributes>

The value in the field descriptions documentation will show as ExtendedAttribute.EXAMPLE and for line items AckLines.ExtendedAttribute.EXAMPLE.

 For Suppliers:

To learn more about how to integrate sending acknowledgements using the XML format see this link.

 For Retailers:

To learn more about how to integrate receiving acknowledgements from your partners using the XML format see this link.

EDI
Download EDI Specs and Samples

 

Click the link above to download the standard 855 specification and samples. All fields listed below reflect the model schema for the Logicbroker standard 855. For example the snippet below would match the EDI field name N102 (ST) - ShipToAddress.CompanyName in the Field Descriptions below. The value in the parenthesis (ST) will represent the qualifier in the previous element; in this case its N101.

N1*ST*Merchant Co~

For EDI fields in a loop, such as line items, they will be identified by being separated with a ":" for example PO1:ACK02 (IA) would be represented below. "PO1:" indicates the element is under the PO1 loop. ACK02 identifies the element value and the parenthesis "(IA)" represents the related qualifier of "IA" present in ACK01.

✨ Tip:

The ACK segment can be used 3 times under the PO1 loop to indicate accepted (IA), cancelled (IR), and backordered (IB) quantities. 
PO1*1*90*EA***VN*V-123123*IN*1234567*UP*0123456789012~
ACK*IA*88*EA~
ACK*IB*1*EA~
ACK*IR*1*EA~
DTM*068*20160728~

 For Suppliers:

To learn more about how to integrate sending acknowledgements using the EDI format see this link.

 For Retailers:

To learn more about how to integrate receiving acknowledgements from your partners using the EDI format see this link.

CSV
Download CSV Samples

 

Click the link above to download the CSV samples. Note by default if you are retrieving acknowledgements from Logicbroker's SFTP/FTP a simplified version is identified with the "EXPORT" annotation on the file name.

To receive the format as listed below in the Field Descriptions, please contact support@logicbroker.com. All fields listed below reflect the model schema for the Logicbroker standard CSV format. For example the snippet below would match the field name ShipToAddress.CompanyName in the Field Descriptions below.

Id,ShipToAddress.CompanyName
221804,Merchant Co

If there is a field that is missing in the structure you can add custom fields as an extended attribute on the header level or item level; see example below. Note when a custom field is added, you will need to notify Logicbroker to ensure it is mapped to your partners.

Id,ExtendedAttribute[Name=EXAMPLE].Value
221804,Portal

The value in the field descriptions documentation will show as ExtendedAttribute.EXAMPLE and for line items AckLines.ExtendedAttribute.EXAMPLE

✨ Tip:

When submitting or receiving a CSV acknowledgement, each row will be split out for each line item. If you are submitting an acknowledgement to Logicbroker for creation, the line items will get consolidated into one acknowledgement if they share the same AcknowledgementNumber and PartnerPO.

 For Suppliers:

To learn more about how to integrate sending acknowledgements using the CSV format see this link.

 For Retailers:

To learn more about how to integrate receiving acknowledgements from your partners using the CSV format see this link.

🗒️Note:

Logicbroker has the ability to create custom specifications for any format and file type. Please contact us and attach any samples of your custom format and we can quickly and easily implement it.

Field Descriptions

 

EDI Field Logicbroker 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

3 = Backorder (at the header, treated the same as 0 = AcknowledgeWithChange)

Optional - if not sent the type of acknowledgement will be determined by the Quantites 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

BAK04

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

PO1:ACK:DTM02 (068) or PO1:ACK05 (068)

ScheduledShipDate

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

Required

BAK09

DocumentDate

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

Read Only

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

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

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. For certain partners this may require a specific code; the standard codes are listed below.

Administrative request
Bad address
Cancelled at retailer's request
Cannot fulfill in time
Cannot ship to PO box.
Cannot ship using provided ship method
Customer changed mind
Discontinued item
Duplicate order
Fraud detected
Info missing on purchase order
Invalid SKU
Invalid item cost
Invalid ship method
Item recall
Other
Out of stock

Optional

Troubleshooting acknowledgements

These situations come up most often when suppliers send acknowledgements. Some rules apply to every acknowledgement. Others are set up per retailer, so check your retailer's document standards or ask Support if you are not sure which rules your retailer uses.

To fix a failed acknowledgement in the portal, you replace it rather than edit it.

  1. Open the failed acknowledgement and select More Actions › Ignore. If your account shows Change Status instead, use it to set the document to Ignored. A document that has already been created opens read only, so you cannot edit it.
  2. Open the order and select Accept/Reject.
  3. Enter the corrected quantities and reasons, then select Submit.

If you send acknowledgements by EDI, API or file, correct the data in your system and send a new acknowledgement for the same PartnerPO.

Failed with "Total amount acknowledged is greater than Quantity Ordered" or "you cannot cancel a line for more quantity than what was ordered"

Who this applies to: suppliers sending acknowledgements by portal, EDI, API or file.

What it means: the quantities on a line add up to more than the ordered quantity. Logicbroker counts cancelled and backordered quantities from every acknowledgement on the order, not only the newest one. A line you already cancelled on an earlier acknowledgement still counts.

What to check:

  1. Find the line number and quantities in the error, for example "Qty ordered: 1 vs. Qty acknowledged: 2".
  2. Add the accepted, cancelled and backordered quantities you sent for that line.
  3. Check the earlier acknowledgements on the order for quantities already cancelled on that line.

The fix: send each unit once, as either accepted, cancelled or backordered. For example, on a line ordered with quantity 1, send 1 accepted and 0 backordered, or 0 accepted and 1 backordered. Only include lines and quantities that have not been acknowledged yet. In the portal, Quantity Accepted updates itself when you enter Quantity Cancelled or Quantity Backordered, so check it before you submit.

How to check it worked: the new acknowledgement does not show as Failed. For the order to close, shipped and cancelled quantities on each line must add up to the ordered quantity.

When to contact Support: if the error names a line you did not change, or the order quantities look wrong. Include the PO number, the acknowledgement ID, the exact error and the quantities you sent.

Failed because the retailer does not allow backorders or partial line cancellations

Who this applies to: suppliers whose retailer has turned on one of these rules. Not every retailer uses them.

What it means: some retailers do not accept backordered quantities. Others do not allow you to cancel part of a line. When a partial cancellation is blocked, the error starts with "The following lines cannot be cancelled because partial line cancellation is not allowed" and lists each line, for example "Tried to cancel 1 of 2 ordered".

What to check:

  1. Read the retailer's document standards or test cases to see whether they accept backorders and partial cancellations.
  2. Compare the quantities on the failed acknowledgement with what the retailer allows.

The fix:

  • Backorders not allowed: if you will ship the item, accept it. If you cannot ship it in time, cancel it.
  • Partial line cancellations not allowed: cancel the full quantity on the line, or accept the full quantity.

How to check it worked: the new acknowledgement does not show as Failed, and the order moves on. Accepting all items typically moves the order to Ready to Ship (500). Cancelling all items moves it to Cancelled (1100).

When to contact Support: if shipments or invoices for the order also failed because the order was not acknowledged. Include the PO number, the failed document IDs and the exact errors.

Cancellation failed because a cancellation reason is missing

Who this applies to: suppliers whose retailer requires a reason on each cancelled line. Not every retailer requires one.

What it means: the acknowledgement cancels quantity on a line but does not include a reason for that line.

What to check:

  1. Confirm that you meant to cancel the items. If you plan to ship them, do not resend the cancellation. Set the failed acknowledgement to Ignored and send the shipment.
  2. If the cancellation is correct, check that each cancelled line has a reason in AckLines.ChangeReason.

The fix: set the failed acknowledgement to Ignored and create a new one. In the portal, choose a reason in the Change Reason column for every line with a cancelled quantity, then select Submit.

How to check it worked: the new acknowledgement does not show as Failed, and the cancelled quantities appear on the order.

When to contact Support: if you did not send the cancellation and do not know where it came from. Include the PO number, the acknowledgement ID and how you connect to Logicbroker.

A line fails to match, or the wrong line was cancelled

Who this applies to: suppliers sending acknowledgements by any method.

What it means: each acknowledgement line must match a line on the original order. SKUs are case sensitive, so "ABC-6oz" and "ABC-6OZ" are different SKUs. A line that does not match can fail with an error that seems unrelated, such as a price mismatch.

What to check:

  1. Compare the SupplierSKU, PartnerSKU and LineNumber on the acknowledgement with the order, character by character, including upper and lower case.
  2. Check that you returned the line number from the order and did not renumber the lines.

The fix: send the SKU and line number exactly as they appear on the order. If your system changes the case of SKUs, correct that before you resend.

If you cancelled the wrong line: once a cancellation has been accepted, you cannot accept that line again yourself, and a shipment for it can fail. Contact Support before you send anything else for the order.

How to check it worked: the acknowledgement does not show as Failed, and each line shows the quantities you sent.

When to contact Support: include the PO number, the acknowledgement ID, the line numbers and SKUs involved, and the exact error.

The ship date shows as 01/01/0001 or the retailer rejects the ship date

Who this applies to: suppliers sending a scheduled ship date, mainly by EDI. Some retailers have their own ship date rules.

What it means: 01/01/0001 in the Estimated Ship Date field means no ship date was saved on the acknowledgement. Some retailers also reject a scheduled ship date that is in the past.

What to check:

  1. In EDI, check that the date is in the format CCYYMMDD and follows the 068 qualifier, either in the line ACK segment (for example ACK*IA*3*EA*068*20261016~) or in a DTM segment (for example DTM*068*20261016~).
  2. If your retailer rejects past dates, check that the date is today or later.
  3. In the portal, check the Estimated Ship Date field before you submit. It may be filled in for you from a default number of ship days.

The fix: send a new acknowledgement with a valid date that meets the retailer's rules. When testing, use orders whose dates are still in the future.

How to check it worked: the acknowledgement shows the date you sent in Estimated Ship Date.

When to contact Support: if the date still shows as 01/01/0001 or the acknowledgement fails before the retailer's test case runs. Include the PO number, the acknowledgement ID and the raw EDI file you sent.

We're updating this article. Some steps and screenshots may not match the portal yet. If anything is unclear, contact support@logicbroker.com.