This JSON object should be stringified and passed in as the "params" attribute of the GetItemInventory API.
- isodate fields use one of these ISO 8601 formats: 2014-01-01T10:30:00.000+01:00, 2014-01-01T10:30:00.000+0100, 2014-01-01T10:30:00.000Z
- Dsco reserves the right to add new attributes at any time so Partners should ensure their validators won't break should this happen
Attributes
Name | Req | Type | Description |
---|---|---|---|
resultType | ✓ | enum | How the results will be returned, one of...
|
highWaterMarkQuery | A | string | Return all changed ItemInventory since the last API call, indicated by this highWaterMark value which was returned with the last API call made If this is the first time calling the API and you don't have a highWaterMark value to pass in then simply pass in an iso8601 date to begin getting changes from |
itemIdQuery | A | ItemIdQuery | Search for a single ItemInventory object by one of its identifiers; this or one of the other A attributes must be present, but only one may be |
dateQuery | A | DateQuery | Search for all ItemInventory that fit within this date range; this or one of the other A attributes must be present, but only one may be |
dscoSupplierId | int | Dsco's unique ID for a supplier... If the account making calling this API is a retailer, then filter the results to be within this supplier; if both dscoSupplierId and dscoSupplierTradingPartnerId are provided the API will error out If provided by a supplier the API will error out |
|
dscoSupplierTradingPartnerId | enum | The retailer-provided identifier for a supplier... If the account making calling this API is a retailer, then filter the results to be within this supplier; if both dscoSupplierId and dscoSupplierTradingPartnerId are provided the API will error out If provided by a supplier the API will error out |
|
assortmentId | string | If provided, filter the results to only those items that have been associated with the given assortment | |
omitItemsOnHold | boolean | Defaults to true if not provided If true, do not include items associated with a supplier that is on hold |
|
clearQuantityForStoppedItems | boolean | Defaults to true if not provided If true, zero out quantity (at top-level and in warehouses) and set status to out-of-stock for any items associated with a stopped supplier |
|
callbackUrl | string | Required if resultType is file This is the URL Dsco will send the following JSON object to when the file has been generated and is ready to be downloaded by the partner who made the request... object
|
|
callbackHeaders | Array of object
|
Optional if resultType is file, otherwise it's an error to include Request headers to include when Dsco calls the callbackUrl |
Examples
{ "resultType": "objects", "dateQuery": <DateQueryObject>, "dscoSupplierTradingPartnerId": "acme supplier 123", "assortmentId": "7ca5e5f1-3239-426f-80dd-e4c26632c30c", "omitItemsOnHold": false, "clearQuantityForStoppedItems": false }
{ "resultType": "file", "dateQuery": <DateQueryObject>, "dscoSupplierTradingPartnerId": "acme supplier 123", "assortmentId": "7ca5e5f1-3239-426f-80dd-e4c26632c30c", "omitItemsOnHold": false, "clearQuantityForStoppedItems": false, "callbackUrl": "http://acme.retailer.com/callback", "callbackHeaders": [ {"name": "auth", "value": "23424242"} ] }
Comments
Please sign in to leave a comment.