5 setDSAcknowledge Response Message

Overview: The Supplier Direct Fulfillment module sends the setDSAcknowledge response message when it receives the setDSAcknowledge Request Message confirming that a batch of purchase orders was received through the getDSOrders Response Message

Acknowledgement is by batch only. It is not possible to acknowledge individual purchase orders.

In this chapter:

For more information: See:

Sample setDSAcknowledge Response Message

The following sample indicates that the batch was successfully acknowledged.

Sample Message Header

Troubleshooting the setDSAcknowledge Response

If the response does not indicate that the batch was successfully updated, the responseCd and responseDescription indicate the problem identifying the batch.

Sample Unsuccessful Response

The following sample indicates that the batch has already been acknowledged.

Response Codes and Descriptions

The following table lists possible response codes and descriptions returned if there are no new purchase orders matching the criteria passed in the request message.

responseCd responseDescription Explanation

3000

FAILED - Invalid or Missing Destination (locateq)

The destination specified in the request did not match the Account specified at the Tenant - Admin screen.

3001

FAILED - Message version 4.5 or higher required.

The version specified in the request was lower than 4.5.

3002

Invalid or missing vendor code, (vendorCd) is required.

No vendorCd was specified in the request

3003

Invalid or missing vendor system code, (vendorSystemCd) is required.

No vendorSystemCd was specified in the request.

3004

Invalid vendor system code, system (vendorq) does not exist.

The vendorSystemCd is not a valid system.

3005

Invalid vendor code, vendor (12345) does not exist in system (vendor).

The vendorCd is not valid for the vendorSystemCd. The vendorSystemCd needs to specify the vendor system, not the system where the purchase order originates.

The Invalid vendor code error is also returned if the request message fails OAuth validation based on the Client ID or token.

3020

Invalid batch, batch id (1396) is not associated to vendor (257). The batchId specifies a batch that is not valid for the vendorCd.

3021

Request already at provided status. The batchId specified has already been acknowledged.

getDSAcknowledge Response Message Contents

The typical vendor integration process:

Message Element or Attribute Alpha/numeric Description

messageHeader

Example

Message Header

Basic communication information

datetime

datetime

The date and time when the response message was generated. Based on the retailer’s system’s time

version

numeric

From the version in the setDSAcknowledge Request Message.

source

alphanumeric

From the destination in the setDSAcknowledge Request Message.

destination

alphanumeric

From the source in the setDSAcknowledge Request Message.

messageBody

Example

Message Body

Returns the information from the request and indicates whether the request was successful.

vendorCd

alphanumeric

The number assigned by the retailer to identify the vendor fulfilling the drop ship order. From the vendorCd in the setDSAcknowledge Request Message.

vendorSystemCd

alphanumeric

The vendor system code assigned by the retailer. From the vendorSystemCd in the setDSAcknowledge Request Message.

remaining

numeric

The remaining number of purchase orders matching the criteria specified in the request message. This number might be higher than zero when, for example, the request message specifies an item and a batchSize that is lower than the total number of new purchase orders for the item.

batchID

numeric

The number assigned to identify the batch of purchase orders.

responseCd

numeric

Set to 0 if the acknowledgement was successful. See Troubleshooting the setDSAcknowledge response for information on other possible response codes.

responseDescription

alphanumeric

Set to Successfully Updated if the acknowledgement was successful.

See Troubleshooting the setDSAcknowledge response for information on other possible response descriptions.