setDSShipConfirm Response Message

7 setDSShipConfirm Response Message

Overview: The Supplier Direct Fulfillment module sends the setDSShipConfirm response message when it receives the setDSShipConfirm Request Message confirming that a purchase order has been shipped.

In this chapter:

For more information: See:

Sample setDSShipConfirm Response Message

The following sample indicates that the shipment was successfully confirmed.

Troubleshooting the setDSShipConfirm Response

If the response does not include at least one purchase order, the responseCd and responseDescription indicate the shipment confirmation was unsuccessful.

Sample Unsuccessful Response

The following sample indicates that the request did not specify a valid carrier associated with the vendor.

Response Codes and Descriptions

The following table lists possible response codes and descriptions returned if shipment specified in the request message could not be confirmed.

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.
3031	`Invalid PO (999) is not associated to vendor (11).`	The `poNo` specified is not a valid purchase order number for the vendor.
3032	`Invalid Carrier (a) is not associated to vendor (11).`	The `carrierCd` specified is not a valid carrier for the vendor
3033	`Tracking Number is a required field.`	No `trackingNumber` is specified, and the tracking number is required for the carrier.
3034	`Shipping Weight is a required field.`	The `actualWeight` specified is 0, and the shipping weight is required for the carrier.
3035	`Shipping Rate is a required field.`	The `meterCharges` is 0, and shipping rate is required for the carrier.
3036	`Ship Date is invalid.`	No `shipDate` is specified.
3037	`Ship Date is invalid, ship date cannot be before create date.`	The `shipDate` is before the date when the purchase order was created.
3038	`Carrier is a required field.`	No `carrierCd` is specified.
3042	`Invalid PO Line (99) is not associated to PO (747).`	The `poLineNo` does not specify an existing line on the purchase order. This error detail response occurs with header-level error `3050`, described below.
3043	`Invalid Qty, shipped quantity.`	The `shippedQty` is 0. This error detail response occurs with header-level error `3050`, described below.
3044	`Invalid Qty, shipped quantity cannot exceed the available to ship.`	The `shippedQty` specified exceeds the unshipped, uncanceled quantity on the purchase order line. This error detail response occurs with headerlevel error `3050`, described below.
3050	`Invalid PO Lines provided.`	The `poLineNo` does not specify an open purchase order line.

setDSShipConfirm Response Message Contents

Message Element or Attribute	Alpha/numeric	Description
errorDetail Example		Includes information if there is an error related to a purchase order line. See Response Codes and Descriptions for more information.
poLineNo	alphanumeric	The purchase order line number in error
shippedQty	alphanumeric	The shipped quantity indicated for the purchase order line number in error.
responseCd	alphanumeric	The response code associated with the error
responseDescription	alphanumeric	The description of the error.
messageHeader Example		Basic communication information
datetime	datetime	The date and time when the response message was generated. In the retailer’s system’s time zone.
version	numeric	From the `version` in the setDSShipConfirm Request Message.
source	alphanumeric	From the `destination` in the setDSShipConfirm Request Message.
destination	alphanumeric	From the source in the getDSOrders Request Message.
messageBody Example		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 setDSShipConfirm Request Message.
vendorSystemCd	alphanumeric	The vendor system code assigned by the retailer. From the `vendorSystemCd` in the setDSShipConfirm Request Message.
poNo	alphanumeric	From the `poNo` in the setDSShipConfirm Request Message.
carrierCd	alphanumeric	From the `carrierCD` in the setDSShipConfirm Request Message.
meterCharges	numeric	From the `meterCharges` in the setDSShipConfirm Request Message.
shipdate	datetime	From the `shipDate` in the setDSShipConfirm Request Message.
actualWeight	numeric	From the `actualWeight` in the setDSShipConfirm Request Message.
trackingNumber	alphanumeric	From the `trackingNumber` in the setDSShipConfirm Request Message.
responseCD	numeric	Set to 0 if the acknowledgement was successful. See Troubleshooting the setDSShipConfirm response on page 7- 2 for information on other possible response codes.
responseDescription	alphanumeric	Set to `Successfully Updated` if the acknowledgement was successful. See Troubleshooting the setDSShipConfirm response on page 7-2 for information on other possible response descriptions.