2 getDSOrders Request Message

Overview: Use the getDSOrders request message to request new purchase orders for fulfillment.

Limit batch size?: The getDSOrders request message can use the batchSize value to specify a maximum number of purchase orders to include in the response message if the criteriaType is "item" or "all PO". If the criteriaType is "PO", then the response includes only the specific purchase order.

Endpoint and resource:

The endpoint for this message is https://<SERVER>:<PORT>, where <SERVER> is the name of the server and <PORT> is the port.

The resource for this message is /Locate/adws/DSOrders/getDSOrders.

In this chapter:

• Sample getDSOrder Request Message

• getDSOrders Request Message Contents

For more information: See:

• Vendor Integration Overview for background.

• getDSOrders Response Message for information on the response message generated to the getDSOrder request message and the causes of possible errors.

Sample getDSOrder Request Message

All purchase orders: The following sample requests all new purchase orders assigned for fulfillment.

getDSOrders Request Message Contents

Message Element or Attribute	Alpha/Numeric	Description
messageHeader Example:
datetime	datetime	Standard datetime format (YYYY-MMDDTHH: MM:SS, or 2013-09- 25T07:32:01). Required, and must be formatted correctly; should not include the offset from Greenwich Mean Time (for example, pass 2013-09- 25T03:02:47.118 rather than 2013- 09-25T03:02:47.118-05:00.
version	alphanumeric	Indicates the current version of Oracle Retail Order Broker. Must be set to 4.5 or higher. Required.
source	alphanumeric	The external system originating the request. Required.
destination	alphanumeric	The name of the Oracle Retail Order Broker database. Must match the Account value specified at the Tenant - Admin screen; however, not case-sensitive. Normally set to locate.
Identifying Information Example:
vendorCd	alphanumeric	A code identifying the vendor to fulfill the purchase order. Required.
vendorSystemCd	alphanumeric	A code identifying the default vendor system for the organization (not the system originating the purchase orders). Required.
batchSize	numeric	The maximum number of purchase orders to include in the response. The batchSize is used only when the criteriaType is All PO or item. Also, the number of purchase orders returned does not exceed the threshold defined in the CTL_APP_CONFIG database table, regardless of the batchSize specified; this threshold is set to 500 by default.
Criteria Example:
criteriaType	alphanumeric	Controls how to select the purchase orders to include in the response. Possible types: All PO: include all eligible purchase orders. Only new purchase orders that have not yet been assigned a batch number are eligible. item: include purchase orders that include the specified item on a purchase order line. Only new purchase orders that have not yet been assigned a batch number are eligible. PO: include the specified purchase order. Only the specified purchase order is eligible, and only if it has not yet been assigned a batch number. batch: Include all purchase orders assigned to the specified batch. You can request the same batch multiple times, and the purchase orders in the batch are returned in the response regardless of their current status.
criteriaValue	alphanumeric	The value that the purchase orders returned in the response need to match. If the criteriaType is: All PO: The criteriaValue is not used. item: The criteriaValue needs to specify a vendor item code for the vendor to have the response include eligible purchase orders (new order status, no batch number assigned) that include that item. Not case-sensitive. PO: The criteriaValue needs to specify a single eligible purchase order (new order status, no batch number assigned) for the vendor. batch: The criteriaValue needs to specify a batch for the vendor. The batch does not need to be in new order status.