| Oracle® Retail Omnichannel Cloud Data Service Implementation Guide Release 19.1.000 F32140-01 |
|
 Previous |
| Oracle® Retail Omnichannel Cloud Data Service Implementation Guide Release 19.1.000 F32140-01 |
|
Previous |
The v2 series of REST Endpoint has been expanded in v19.1 to include all the v1 endpoints plus additional new endpoints. The v2 series of endpoints provides better throughput and more consistent performance for paged data sets. The data content returned by a v2 endpoint is compatible with the v1 endpoint. The v2 version might have additional fields added but retains the v1 data fields. All new clients to OCDS should use the v2 endpoints for data retrieval. It is highly recommended that current OCDS clients using v1 endpoints update to use the v2 endpoints.
Following is an example of the json structure in the response from an OCDS REST endpoint:
{
"items": [
{
"logged": "2020-05-01T12:54:36.618000000-05:00",
"severity": "INFO",
"message": "OcdsImport_PriceClearance.xferPriceClearance - start",
"supplemental": "INFO"
},
{
"logged": "2020-05-01T12:59:51.225000000-05:00",
"severity": "INFO",
"message": "OcdsImport_PriceClearance.deleteBdiIfcRecord - begin",
"supplemental": "INFO"
},
{
"logged": "2020-05-01T13:00:44.028000000-05:00",
"severity": "INFO",
"message": "OcdsImport_DiffGrp.xferDiffGrp - start",
"supplemental": "INFO"
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [
{
"rel": "self",
"href": "http://{server}:{port}/ords/ocds/omnichannel/v2/admin/log?limit=3&since=1970-01-01T00:00:00.001000000+00:00&before=2020-05-06T13:26:44.515000000-05:00"
},
{
"rel": "describedBy",
"href": "http://{server}:{port}/ords/ocds/omnichannel/metadata-catalog/v2/admin/log"
},
{
"rel": "next",
"href": "http://{server}:{port}/ords/ocds/omnichannel/v2/admin/log?limit=3&offsetkey=2020-05-01T13:00:44.028000000-05:00"
}
]
}
Summary of the elements in the json response:
| Element | Value | Description |
|---|---|---|
| items | NA | Array of json objects returned by the request. If no matching objects are found the array will have no elements |
| hasMore | NA | Boolean flag to indicate if more data is available |
| limit | NA | Maximum number of records to return in the request |
| count | NA | Count of records returned in the response. This will be less than or equal to the limit value |
| links.rel | self | This pair of elements shows the calling url |
| links.href | NA | The current request url |
| links.rel | describedBy | This pair of elements provides the link to the metadata catalog |
| links.href | NA | Link to the metadata-catalog listings for the endpoint |
| links.rel | next | If the hasMore flag is true, this pair of elements will be populated. |
| links.href | NA | Only present if the hasMore flag is trueLink to the next page of data. Applications should the value of the href element to access the next page of data. This url contains a server generated offsetkey parameter to identify the start of the next page. |
|
Note: In sample data sections of the REST Endpoint descriptions, the links element has been compressed to "links": [ {.. } ]. |
Get the log entries for a specified severity and/or time range.
GET /ords/ocds/omnichannel/v2/admin/log
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| severity | ERROR
INFO DEBUG |
Severity of the requested log entry. All log entries are returned when no severity parameter is specified | Yes | Query | String |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
|---|---|
| logged | Timestamp when the entry was recorded. |
| severity | Severity of the log entry. Will be ERROR, INFO, or DEBUG. |
| message | Log message from OCDS. |
| supplemental | Supplemental information for the log entry. |
Content-Type: application/json:
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/admin/log?severity=INFO&since=2018-01-23T16:26:41.485Z:30&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"logged": "2020-05-01T12:54:36.618000000-05:00",
"severity": "INFO",
"message": "OcdsImport_PriceClearance.xferPriceClearance - start",
"supplemental": "beginSeq: 0, endSeq: 2426058"
},
{
"logged": "2020-05-01T12:59:51.225000000-05:00",
"severity": "INFO",
"message": "OcdsImport_PriceClearance.deleteBdiIfcRecord - begin",
"supplemental": "beginSeq: 0, endSeq: 2426058"
},
{
"logged": "2020-05-01T13:00:44.028000000-05:00",
"severity": "INFO",
"message": "OcdsImport_DiffGrp.xferDiffGrp - start",
"supplemental": "beginSeq: 0, endSeq: 103"
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get the OCDS version and installed patch releases. Diffs are special purpose attributes used to define concepts that differentiate items that are closely related, but not the same. Diffs are used to define colors, sizes, patterns, scents and flavors.
GET ords/ocds/omnichannel/v2/admin/version
No parameters are supported for this endpoint.
| Field | Description |
|---|---|
| version | Base build number of the OCDS deployment |
| hotfix | Applied hot fix number |
| installed | Installation date. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/admin/log?severity=ERROR&since=2018-01-23T16:26:41.485Z:30&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"version": "19.1.000",
"hotfix": "000",
"installed": "2020-05-01T12:50:19.045000000-05:00"
}
],
"hasMore": false,
"limit": 10000,
"count": 1,
"links": [ {.. } ]
]
}
Get the changes made to Diffs since a point in time. Diffs are special purpose attributes used to define concepts that differentiate items that are closely related, but not the same. Diffs are used to define colors, sizes, patterns, scents and flavors.
GET ords/{system}/omnichannel/{version}/diff
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| diffid | The unique ID of the diff. Data will always be present in this field. |
| diffdesc | The type code for the diff. All diffs belong to one any only one type. |
| difftype | A value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table. |
| difftypedesc | The description of the diff. Data will always exist in this field. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/diff?since=2018-01-23T16:26:41.485Z:30&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"diffid": "AUTOBLACK",
"diffdesc": "Auto Black",
"difftype": "AUTO_C",
"difftypedesc": "Auto Color"
},
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [ {.. } ]
}
Get the changes made to Diff Groups since a point in time.
GET ords/ocds/omnichannel/v2/diff/group
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| diffgroupid | A unique number id for the differentiator group. Data will always be present in this field. |
| diffgroupdesc | Description of the differentiator group (for example: Mens Shirt Sizes, Womens Shoe Sizes, Girls Dress Sizes, Shower Gel Scents, Yogurt Flavors, etc.). Description data is only sent in the primary integration language of the system. |
| difftypeid | A value of the types of differentiators contained in this differentiator group, including but not limited to: S (size), C (color), F (flavor), E (scent), P (pattern). |
| diffid | Contains the description of the differentiator type. For Example: Size, Color, Flavor, Scent, Pattern. Description data is only sent in the primary integration language of the system. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/diff/group?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"diffgroupid": "AUTO CLRS",
"diffgroupdesc": "Auto Basic Color Pallet",
"difftypeid": "AUTO_C",
"diffid": "1"
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [ {.. } ]
}
Get the changes made to future inventory since a point in time.
GET ords/ocds/omnichannel/v2/inventory/future
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0..n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| item | A unique identifier for the item. Data will always be present. |
| onorderquqntity | Quantity on order for this item. |
| receivedquantity | Quantity of the item received. |
| backorderquantity | Backorder quantity for the item. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/inventory/future?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"item": "1",
"onorderquantity": 0,
"receivedquantity": 94,
"backorderquantity": 0
},
{
"action": "INSERT",
"item": "10",
"onorderquantity": 11,
"receivedquantity": 20,
"backorderquantity": 15
},
{
"action": "INSERT",
"item": "100",
"onorderquantity": 33,
"receivedquantity": 86,
"backorderquantity": 21
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ] ]
}
Get the changes made to store inventory since a point in time.
GET ords/ocds/omnichannel/v2/inventory/store
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0..n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| item | A unique identifier for the item. Data will always be present. |
| location | Location identifier for the inventory |
| loctype | Will be S for store |
| availablequantity | Available quantity |
| stockonhand | Quantity on hand |
| standarduom | Standard unit of measure for the item |
| physicalwarehouse | Boolean to indicate if the location is a physical warehouse |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/inventory/warehouse?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"item": "100000",
"location": "1",
"loctype": "S",
"availablequantity": 42,
"stockonhand": 30,
"standarduom": "EA"
},
{
"action": "INSERT",
"item": "1000001",
"location": "1",
"loctype": "S",
"availablequantity": 35,
"stockonhand": 63,
"standarduom": "EA"
},
{
"action": "INSERT",
"item": "1000012",
"location": "1",
"loctype": "S",
"availablequantity": 40,
"stockonhand": 7,
"standarduom": "EA"
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get the changes made to store inventory since a point in time.
GET ords/ocds/omnichannel/v2/inventory/warehouse
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0..n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| item | A unique identifier for the item. Data will always be present. |
| location | Location identifier for the inventory |
| loctype | Will be W for store inventory |
| availablequantity | Available quantity |
| stockonhand | Quantity on hand |
| standarduom | Standard unit of measure for the item |
| physicalwarehouse | Boolean to indicate if the location is a physical warehouse |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/inventory/warehouse?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"item": "1",
"location": "1",
"loctype": "W",
"availablequantity": 12,
"stockonhand": 99,
"standarduom": "EA",
"physicalwarehouse": null
},
{
"action": "INSERT",
"item": "10",
"location": "1",
"loctype": "W",
"availablequantity": 26,
"stockonhand": 40,
"standarduom": "EA",
"physicalwarehouse": null
},
{
"action": "INSERT",
"item": "100",
"location": "1",
"loctype": "W",
"availablequantity": 32,
"stockonhand": 51,
"standarduom": "EA",
"physicalwarehouse": null
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get changes made to items since a point in time.
GET ords/ocds/omnichannel/v2/item
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| itemlocation | The Organization Hierarchy Node id when requested by node, otherwise "ent" (Enterprise) is returned. |
| item | ID of item. Data will always be present in this field. |
| itemparent | ID identifies the item/group at the level above the item. This value must exist as an item in another row on the item_master table. |
| itemgrandparent | ID identifies the item/group two levels above the item. This value must exist as both an item and an item parent in another row on the item_master table. |
| itemlevel | Number indicating which of the three levels the item resides. The item level determines if the item stands alone or if it is part of a family of related items. The concept is best explained with typical (although not exhaustive) examples. Staple items generally have a item level = 1 UPCs for Staple items generally have an item level = 2 (and the staple item will be the UPCs parent item). Fashion styles generally have an item level = 1. Fashion skus generally have an item level = 2. If UPCs for fashion skus generally have an item level = 3. Valid values are 1, 2 and 3. This field will always have data. |
| tranlevel | Number indicating which of the three levels transactions occur for the items group. The transaction level is the level at which the items inventory is tracked in the system. The transaction level item will be inventoried, counted, transferred, shipped, etc. Only one level of the hierarchy of an item family may contain transaction level items. The concept is best explained with typical (although not exhaustive) examples. Staple items generally have a TranLevel = 1. UPCs for Staple items generally have an TranLevel = 1 (inventory txns occur at the staple sku level; sales of the item roll up to the parent staple sku). Fashion styles generally have a TranLevel = 2 (the style itself is not sold/inventoried). Fashion skus generally have an TranLevel = 2 (the fashion sku is sold/inventoried). If UPCs for fashion skus generally have an TranLevel = 2 (the fashion sku is sold/inventoried). There are some rare cases in vendor managed inventory where the TranLevel = 3. Valid values are 1, 2 and 3. This field will always have data. |
| inventoryind | This indicator is used to determine if inventory is held for the item/item family. Inventory is held for most items. However, inventory is not held (value = N) in some special cases, such as: Concession items (items that are sold by independent in location concessions), Consignment items (items are not owned by the retailer; financial and inventory processing occurs after the item is sold to a consumer), Containers sold then returned for deposit and some items that are transformed for sale. Valid values are Y and N. This field will always have data. |
| diff1level | This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id. |
| diff1type | This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table. |
| diff1 | Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz). |
| diff2level | This field will contain either ID or GROUP, based on whether the diff_2 is a group diff or a diff id. |
| diff2type | This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table. |
| diff2 | Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz). |
| diff3level | This field will contain either ID or GROUP, based on whether the diff_3 is a group diff or a diff id. |
| diff3type | This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table. |
| diff3 | Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz). |
| division | Number identifying the Division in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same division. This data is required |
| groupid | Number identifying the Group in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same group. This data is required |
| dept | Number identifying the department in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department. This data is required |
| class | Number identifying the class in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department and class. Class is not a unique ID (for example, every department can have a class 1). This data is required. |
| uniqueclass | Number identifying the class in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department and class. Class is not a unique ID (for example, every department can have a class 1). This data is required. |
| subclass | Number identifying the subclass in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department, class and subclass. Subclass is not a unique ID (for example, every department/class can have a subclass 1). This data is required. |
| uniquesubclass | Number uniquely identifying the subclass node which the item belongs to. Subclass is not unique ID the merchandise hierarchy. The combination of Dept/Class/Subclass is unique, but requires use of a composite key. The composite key is generally used in user interfaces. The unique ID can be used in back end processing or in systems that can not have a composite key for a node in the merchandise hierarchy. |
| description | Primary description of the item in the integration language of the system. This value is required. |
| localdescription | The local description of the item, when requesting by Organization Hierarchy Node and Hierarchy level is "STORE". This may be the same as the primary description of the item, a regional description of the item (for example, jimmies vs sprinkles in the US or roll vs bap vs cob vs bun in the UK), or a value in a local language (for example, Overlay dress true black knit at US stores vs Lagenkleid - Strick, tiefschwarz at stores in Germany). The intent is that this string is appropriate to print description on signage/receipts at this location. This will be null for all non-STORE Hierarchy levels. |
| merchandiseind | Indicates if the item is a merchandise item (Y, N). Merchandise items are generally physical items (things that must be shipped/received and of which there is an inventory). Non merchandise items are often items which do not have inventory. Common examples include extra fees for service (extended warranties, alterations) or endlessly available items (downloads, in app purchases of bonus content, subscriptions). All items, both merchandise and non-merchandise are exported from RMS. This value is required. |
| uintype | The unique identification number (UIN) used to identify the instances of the item at the location. |
| mfgrecretail | Manufacturers recommended retail price for the item. Used for informational purposes only. This field is stored in the primary currency. |
| originalunitretail | The original retail price of the item per unit. This field is stored in the primary currency. |
| catchweightind | Indicates whether the item should be weighed when it arrives at a location. Valid values for this field are Y and N. This field will always have data'; |
| itemservicelevel | Holds a value that restricts the type of shipment methods that RCOM can select for an item. |
| giftwrapind | This field will contain a value of Y if the item is eligible to be gift wrapped. If not explicitly defined, this field will default to N. This field will always have data records. |
| shipaloneind | This field will contain a value of Y if the item must be shipped alone to consumers. If not explicitly defined, this field will default to N. This field will always have data records. |
| standarduom | Unit of measure in which stock and or financials of the item is tracked at a corporate level. Unit of measure reference values may have to be manually synced between the systems as this is foundation data that is not currently bulk integrated out of Merch. This value is required. |
| productclassification | Description of the product classification. |
| xdiff1desc | When diff1level is ID, the description of the diff. When diff1level is GROUP, the description of the differentiator group. |
| xdiff2desc | When diff2level is ID, the description of the diff. When diff2level is GROUP, the description of the differentiator group. |
| xdiff3desc | When diff3level is ID, the description of the diff. When diff3level is GROUP, the description of the differentiator group. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/omnidevpdb/omnichannel/v1/location/retailstore?nodeId=1&nodeLevel=CHAIN&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"itemlocation": "ent",
"item": "100805000",
"itemparent": null,
"itemgrandparent": null,
"itemlevel": 1,
"tranlevel": 2,
"inventoryind": "Y",
"diff1level": "GROUP",
"diff1type": "AUTO_S",
"diff1": "AUTO XS-XL",
"diff2level": "GROUP",
"diff2type": "C",
"diff2": "BASIC CLRS",
"diff3level": null,
"diff3type": null,
"diff3": null,
"division": 2000,
"groupid": 8000,
"dept": 8787,
"class": 16,
"uniqueclass": 294,
"subclass": 16,
"uniquesubclass": 203,
"description": "DK Cala Lily",
"localdescription": null,
"merchandiseind": "Y",
"uintype": null,
"mfgrecretail": null,
"originalunitretail": 9.99,
"catchweightind": "N",
"itemservicelevel":null,
"giftwrapind":"N",
"shipaloneind":"N",
"standarduom": 1,
"xdiff1desc": "Auto XS-XL",
"xdiff2desc": "Basic Color Pallet",
"xdiff3desc": null}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [ {.. } ]
}
Get changes made to item dimension types since a point in time. Dimension Types are the types of dimensions associated with a dimension system. This information is derived from the current item diff usage.
GET ords/ocdsomnichannel/v2/item/dimensiontype
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| itemaction | Changes in the item fields related to the dimension type |
| dimensionsystem | A system-defined code (Style ID) for the generalized dimension structure an item belongs to. |
| dimension | The specific code (Diff Type) values belonging to a dimension system. For example, COLOR, SIZE, etc. |
| description | The text description for a dimension code (Diff Type) used for display. |
| seq | Supportes ordering the dimension type within the dimension system |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/dimensiontype?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/ocds/omnichannel/v2/item/dimensiontype?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"itemaction": "INSERT",
"dimensionsystem": "2000001",
"dimension": "COLOR",
"description": "Color",
"seq": 1
},
{
"action": "INSERT",
"itemaction": "INSERT",
"dimensionsystem": "2000001",
"dimension": "SIZE",
"description": "Size",
"seq": 2
},
{
"action": "INSERT",
"itemaction": "INSERT",
"dimensionsystem": "2000001",
"dimension": "PATTRN",
"description": "Pattern",
"seq": 3
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get changes made to item dimension values since a point in time. Dimension Values are the values associated with each dimension within a dimension system. This information is derived from the current item diff usage.
GET ords/ocds/omnichannel/v2/item/dimensionvalue
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| itemaction | Changes in the item fields related to the dimension type |
| dimensionsystem | A system-defined code (Style ID) for the generalized dimension structure an item belongs to. |
| dimension | The specific code (DiffType) values belonging to a dimension system. For example, COLOR, SIZE, etc. |
| value | The specific value (Diff) that exists for a given dimension type for a given dimension system. This is a coded value, for example, S, M, L, and so on. |
| description | The text description of the value code (Diff). |
| displayseg | Display order for the dimension values |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/dimensionvalue?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"itemaction": "INSERT",
"dimensionsystem": "10",
"dimension": "COLOR",
"value": "C00009C",
"description": "Duke blue",
"displayseq": null
},
{
"action": "INSERT",
"itemaction": "INSERT",
"dimensionsystem": "10",
"dimension": "PATTRN",
"value": "PINSTRPS",
"description": "Pinstripes",
"displayseq": null
},
{
"action": "INSERT",
"itemaction": "INSERT",
"dimensionsystem": "10",
"dimension": "SIZE",
"value": "SIZE_28",
"description": "28",
"displayseq": null
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get changes made to item images since a point in time.
GET ords/ocds/omnichannel/v2/item/image
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| item | Contains the unique alphanumeric identifier for the item, the image is for. |
| imagename | Contains the name of the image of the item |
| imageaddr | Contains the actual path where the file of the image of the item is stored. |
| imageuri | URI to the image. |
| imagedesc | Contains the type of the image of the item. Valid values are defined as member of IITD code type. |
| imagetype | Contains the type of the image of the item. Valid values are defined as member of IITD code type. |
| primaryind | Indicates whether this record is the primary image of the item or not. Valid values are Y(es) and N(o) only. Default to N value if left blank or set as NULL. |
| displaypriority | This field will specify the display sequence order of images associated to the item per priority. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/image?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/ocds/omnichannel/v2/item/image?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"item": "1",
"imagename": "1_0.png",
"imageaddr": "http://www.oracle.com/item/images/",
"imageuri": "http://www.oracle.com/item/images/1_0.png",
"imagedesc": "Image for item 1",
"imagetype": "T",
"primaryind": "Y",
"displaypriority": 0
},
{
"action": "INSERT",
"item": "1",
"imagename": "1_1.png",
"imageaddr": "http://www.oracle.com/item/images/",
"imageuri": "http://www.oracle.com/item/images/1_1.png",
"imagedesc": "Image for item 1",
"imagetype": "T",
"primaryind": "N",
"displaypriority": 1
},
{
"action": "INSERT",
"item": "10",
"imagename": "10_0.png",
"imageaddr": "http://www.oracle.com/item/images/",
"imageuri": "http://www.oracle.com/item/images/10_0.png",
"imagedesc": "Image for item 10",
"imagetype": "T",
"primaryind": "Y",
"displaypriority": 0
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get changes made to item locations since a point in time.
GET ords/{system}/omnichannel/{version}/item/itemlocation
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| loctype | Describes the type of location. Valid values include S (store) and W (warehouse). |
| location | Numeric ID of location. The intersection of location and item is a distinct entity. Data will always be present in this field. |
| item | ID of item. The intersection of location and item is a distinct entity. Data will always be present in this field. |
| sellingunitretail | The unit retail price in the selling unit of measure for the item/location combination. This field is stored in the local currency. |
| sellinguom | Contains the selling unit of measure for an items single-unit retail. |
| taxableind | Indicates if item is taxable at the store |
| localitemdesc | Contains the local description of the item. This may be the same as the primary description of the item, a regional description of the item (for example, jimmies vs sprinkles in the US or roll vs bap vs cob vs bun in the UK), or a value in a local language (for example, Overlay dress true black knit at US stores vs Lagenkleid - Strick, tiefschwarz at stores in Germany). The intent is that this string is appropriate to print description on signage/receipts at this location. |
| status | Current status of item at the store. |
| qtykeyoptions | Determines whether the qty key on a POS should be used for this item at the location. |
| manualpriceentry | Determines whether the price can/should be entered manually on a POS for this item at the location. |
| foodstampind | Indicates whether the item is approved for food stamps at the location. This value will be downloaded to the POS. |
| fixedtarevalue | Holds the value associated of the packaging in items sold by weight at the location. |
| fixedtareuom | Holds the unit of measure value associated with the tare value. The only processing RMS does involving the fixed tare value and UOM is downloading it to the POS. |
| stopsaleind | Indicates that sale of the item should be stopped immediately at the location (i.e. in case of recall etc). |
| returnableind | This field will contain a value of Yes when the item can be returned to the location |
| merchandiseind | Indicates if the item is a merchandise item (Y, N). |
| clearanceind | Flag to indicate if item is on clearance |
| crosssell | Indicates whether the item is a related item with either a "UPSL" or CRSL relationship type value. |
| attacheditem | Indicates whether the item is a related item with either a "SUBS" relationship type value. |
| vatcodes | List of the applicable vat codes and active dates |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/itemlocation?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/ocds/omnichannel/v2/item/itemlocation?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
items: [
{
action: "INSERT",
loc_type: "S",
location: 1151,
item: "100000008",
sellingunitretail: 12,
sellinguom: "EA",
taxableind: "N",
localitemdesc: "Test Item 100000008",
status: "A",
qtykeyoptions: null,
manualpriceentry: null,
foodstampind: null,
fixedtarevalue: null,
fixedtareuom: null,
stopsaleind: null,
returnableind: null,
merchandiseind: "Y",
crosssell: "N",
attacheditem: "N",
vatcodes: "[{"code":"AAA","date":"2018-01-01"},{"code":"AAB","date":"2018-03-01"},{"code":"AAC","date":"2018-06-01"},{"code":"AAD","date":"2018-09-01"}]"
}
],
hasMore: true,
limit: 1,
count: 1,
links: [ {.. } ]
}
Get changes made to item prices since a point in time.
GET ords/ocds/omnichannel/v2/item/price
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| pricetype | INITIAL
REGULAR CLEARANCE |
Request data for a single Price Type | No | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| loctype | Location type |
| location | Location identifier for item price |
| item | Item identifier |
| pricetype | INITIAL, REGULAR, CLEARANCE |
| price | item price |
| effective | Date time when change becomes effective |
| source | If direct, the price was initiated directly. Implied means the price change was implied by another price change |
| eventid | Pricing Service event id for the price activity |
| resetind | Flag to indicate to reset the item to previous price |
| clearanceind | Flag to indicate the item is on clearance |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/price?since=2018-01-23T16:26:41.485+05:30&before=2018-06-23T16:26:41.485+05:30&pricetype=REGULAR
https://{host}:{port}/ords/ocds/omnichannel/v2/item/price?since=2018-01-23T16:26:41.485+05:30&before=2018-06-23T16:26:41.485+05:30&pricetype=INITIAL
items: [
{
action: "INSERT",
location: 1151,
loctype: "S",
item: "100000008",
pricetype: "CLEARANCE",
price: 4.63,
effective: "2018-08-05T00:00:00",
eventid: 2000,
resetind: 1
},
],
hasMore: false,
limit: 10000,
count: 5,
links: [ {.. } ]
}
Get changes made to item dimension types since a point in time. Dimension Types are the types of dimensions associated with a dimension system. This information is derived from the current item diff usage.
GET ords/ocds/omnichannel/v2/item/promotion
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| nodeid | 0..n | Specific node for promotions | Yes | Query | Integer |
| nodelevel | COMPANY
CHAIN AREA REGION DISTRICT STORE |
Level of the target node | Yes | Query | String |
| Field | Description |
| promoid | Promotion identifier. |
| offerid | Offer Identifier. |
| desc | Description of the offer. |
| custdesc | Customer facing description |
| levelcode | The level of the offer. Valid values are: 0 - Item, 1 - Transaction. |
| typecode | The type of the offer. Valid values are: 0 Item Simple, 1 Transaction Simple, 2 - Transaction Buy Get, 3 - Item Buy Get, 4 - Item Gift With Purchase |
| templateid | The template of the offer. Valid values are: 0 - Get Discount, 1 - Buy X, Get Discount, 2 - Spend X, Get Discount, 3 - Get Y for Discount, 4 - Buy |
| couponcode | Coupon code required by the offer |
| couponcodereq | Flag to indicate that a coupon is required |
| startdatetime | Starting date time for the offer |
| enddatetime | Ending date time for the offer |
| canceldatetime | Cancellation date time for the offer |
| rewards | Rewards associated with the offer |
| rewards.rewardid | Reward ID |
| rewards.changetype | Type of change for the reward. Valid values: change by amount (1), change by percent (0), fixed price (2) |
| rewards.changeamount | The change by amount or fixed price amount. |
| rewards.changepercent | Percentage value when change type is change by percent. |
| rewards.qtytodisc | The qty to discount. |
| rewards.qtytodiscuom | UOM of the discount quantity. |
| rewards.appyind | The apply to indicator of the reward. Valid values: Regular only - 0; Clearance only - 1; Regular and Clearance - 2 |
| rewards.pricerestrictcode | Price restriction code. Valid Values are B - Between; G - Greater Than; L - Less Than |
| rewards.pricestrictvalue1 | The first value of the price restriction. |
| rewards.pricerestrictvalue2 | The second value of the price restriction. The second value is only used for between restrictrions |
| rewards.rwardsmerch | Collection of merchandise eligible for reward |
| rewards.rewardsmerch.rewardmerchid | The unique id for the offer reward merch record. |
| rewards.rewardsmerch.mrchlevel | The merchandise level of the row. Valid values are: 1 - Department; 2 - Class; 3 - Subclass; 4 - Parent Item; 5 - Parent/Diff Item; 6 - Transaction Item; 8 - All Departments |
| rewards.rewardsmerch.dept | Department ID |
| rewards.rewardsmerch.class | The non-unique class ID value |
| rewards.rewardsmerch.uniqueclass | The unique class ID value |
| rewards.rewardsmerch.subclass | The non-unique subclass ID value |
| rewards.rewardsmerch.unisubclass | The unique subclass ID value |
| rewards.rewardsmerch.item | Item ID |
| rewards.rewardsmerch.diffid | Differentiator ID |
| rewards.rewardsmerch.excludeind | The exclude indicator of the row |
| rewards.rewardsmerch.canceldatetime | Date time when merchandise reward was cancelled |
| conditions | Collection of conditions for promotion |
| conditions.conditionid | Condition ID |
| conditions.buyspendtype | The buy spend type of the condition. Valid values are: 0 - Quantity, 1 - Amount |
| conditions.buyspendvalue | The buy spend value of the condition |
| conditions.buyuom | The buy UOM of the condition |
| conditions.pricerestrictcode | Price restriction code. Valid Values are B - Between; G - Greater Than; L - Less Than |
| conditions.pricerestrictvalue1 | The first value of the price restriction |
| conditions.pricerestrictvalue2 | The second value of the price restriction. The second value is only used for between restrictrions |
| conditions.conditionsmerch | Collection of merchandise for condition |
| conditions.conditionsmerch.condmerchid | The unique id for the offer condition merch record |
| conditions.conditionsmerch.merchlevel | The merchandise level. Valid values are: 1 - Department; 2 - Class; 3 - Subclass; 4 - Parent Item; 5 - Parent/Diff |
| conditions.conditionsmerch.dept | Department ID |
| conditions.conditionsmerch.class | The non-unique class ID value |
| conditions.conditionsmerch.uniqueclass | The unique class ID value |
| conditions.conditionsmerch.subclass | The non-unique subclass ID value |
| conditions.conditionsmerch.uniquesubclass | The unique subclass ID value |
| conditions.conditionsmerch.item | Item ID |
| conditions.conditionsmerch.diffid | Differentiator ID |
| conditions.conditionsmerch.excludeind | The exclude indicator |
| conditions.conditionsmerch.canceldatetime | Date time condition merchandise was cancelled |
| locations | Collection of locations for the promotion |
| locations.action | Action for the promotion in this location - INSERT, UPDATE, DELETE, UPDATE |
| locations.location | Location for promotion |
| locations.canceldatetime | Date time promotion was cancelled for this location |
Content-Type: application/json:
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/promotion?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/ocds/omnichannel/v2/item/promotion?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
items: [
{
promoid: 3403,
offerid: 843,
desc: "Offer 843 Updated",
custdesc: "Offer 843",
levelcode: 0,
typecode: 0,
templateid: 3,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 731,
changetype: 0,
changepercent: 25,
applyind: 2,
rewardsmerch: [
{
rewardmerchid: 8401,
merchlevel: 8,
excludeind: 0
}
]
}
],
conditions: [ ],
locations: [
{
action: "INSERT",
location: 1898439643
}
]
},
{
promoid: 3403,
offerid: 844,
desc: "Offer 844",
custdesc: "Offer 844",
levelcode: 1,
typecode: 1,
templateid: 0,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-23T23:59:59",
rewards: [
{
rewardid: 732,
changetype: 0,
changepercent: 50,
applyind: 1,
rewardsmerch: [
{
rewardmerchid: 8402,
merchlevel: 1,
dept: 9434,
excludeind: 1
}
]
}
],
conditions: [ ],
locations: [
{
action: "INSERT",
location: 9953588522
}
]
},
{
promoid: 3403,
offerid: 845,
desc: "Offer 845",
custdesc: "Offer 845",
levelcode: 1,
typecode: 2,
templateid: 1,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 733,
changetype: 1,
changeamount: 25,
applyind: 2,
rewardsmerch: [
{
rewardmerchid: 8403,
merchlevel: 1,
dept: 8993,
excludeind: 1
}
]
}
],
conditions: [
{
conditionid: 241,
buyspendtype: 0,
buyspendvalue: 5,
buyuom: "EA",
conditionsmerch: [
{
condmerchid: 8221,
merchlevel: 1,
dept: 6755,
excludeind: 0
}
]
}
],
locations: [
{
action: "INSERT",
location: 8982138499
}
]
},
{
promoid: 3403,
offerid: 846,
desc: "Offer 846",
custdesc: "Offer 846",
levelcode: 1,
typecode: 2,
templateid: 2,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 734,
changetype: 0,
changepercent: 25,
applyind: 2,
rewardsmerch: null
}
],
conditions: [
{
conditionid: 242,
buyspendtype: 1,
buyspendvalue: 50,
conditionsmerch: [
{
condmerchid: 8222,
merchlevel: 3,
dept: 8993,
class: 9713,
uniqueclass: 9713,
subclass: 5179,
uniquesubclass: 5179,
excludeind: 0
}
]
}
],
locations: [
{
action: "INSERT",
location: 7761967237
}
]
},
{
promoid: 3403,
offerid: 865,
desc: "Offer 865 Test",
custdesc: "Offer 865 Teset",
levelcode: 1,
typecode: 1,
templateid: 0,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 751,
changetype: 0,
changepercent: 20,
applyind: 1,
rewardsmerch: [
{
rewardmerchid: 8421,
merchlevel: 1,
dept: 3124,
excludeind: 1
},
{
rewardmerchid: 8422,
merchlevel: 1,
dept: 5536,
excludeind: 1
}
]
}
],
conditions: [ ],
locations: [
{
action: "INSERT",
location: 8392141693
}
]
},
{
promoid: 3403,
offerid: 866,
desc: "Offer 866 Test",
custdesc: "Offer 866 Test",
levelcode: 1,
typecode: 2,
templateid: 1,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 752,
changetype: 0,
changepercent: 30,
applyind: 0,
rewardsmerch: [
{
rewardmerchid: 8423,
merchlevel: 1,
dept: 8993,
excludeind: 1
},
{
rewardmerchid: 8424,
merchlevel: 1,
dept: 6755,
excludeind: 1
}
]
}
],
conditions: [
{
conditionid: 251,
buyspendtype: 0,
buyspendvalue: 3,
buyuom: "BG",
conditionsmerch: [
{
condmerchid: 8231,
merchlevel: 2,
dept: 3124,
class: 5669,
uniqueclass: 5669,
excludeind: 0
}
]
}
],
locations: [
{
action: "INSERT",
location: 5579346692
},
{
action: "INSERT",
location: 8392141693,
canceldatetime: "2018-06-25T13:57:43.000000000Z"
}
]
},
{
promoid: 3403,
offerid: 870,
desc: "870 Offer Test",
custdesc: "870 Offer Test",
levelcode: 1,
typecode: 2,
templateid: 1,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 753,
changetype: 0,
changepercent: 30,
applyind: 0,
rewardsmerch: [
{
rewardmerchid: 8425,
merchlevel: 1,
dept: 6755,
excludeind: 1
},
{
rewardmerchid: 8426,
merchlevel: 1,
dept: 9934,
excludeind: 1
}
]
}
],
conditions: [
{
conditionid: 252,
buyspendtype: 0,
buyspendvalue: 3,
buyuom: "BG",
conditionsmerch: [
{
condmerchid: 8232,
merchlevel: 3,
dept: 3124,
class: 5669,
uniqueclass: 5669,
subclass: 3954,
uniquesubclass: 3954,
excludeind: 0
}
]
}
],
locations: [
{
action: "INSERT",
location: 7761967237
},
{
action: "INSERT",
location: 8392141693
}
]
},
{
promoid: 3403,
offerid: 872,
desc: "Offer 872 Test",
custdesc: "Offer 872 Test",
levelcode: 1,
typecode: 2,
templateid: 2,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 754,
changetype: 1,
changeamount: 10,
applyind: 0,
rewardsmerch: [
{
rewardmerchid: 8430,
merchlevel: 1,
dept: 9978,
excludeind: 1
}
]
}
],
conditions: [
{
conditionid: 253,
buyspendtype: 1,
buyspendvalue: 50,
conditionsmerch: [
{
condmerchid: 8236,
merchlevel: 1,
dept: 3124,
excludeind: 0
},
{
condmerchid: 8237,
merchlevel: 1,
dept: 5536,
excludeind: 0
},
{
condmerchid: 8238,
merchlevel: 1,
dept: 9469,
excludeind: 0
},
{
condmerchid: 8239,
merchlevel: 1,
dept: 5536,
excludeind: 0,
canceldatetime: "2018-06-25T14:08:35.000000Z"
}
]
}
],
locations: [
{
action: "INSERT",
location: 5579346692
},
{
action: "INSERT",
location: 8392141693
},
{
action: "INSERT",
location: 8992251863
}
]
},
{
promoid: 3403,
offerid: 875,
desc: "Offer 875 Test",
custdesc: "Offer 875 Test",
levelcode: 0,
typecode: 0,
templateid: 3,
startdatetime: "2018-02-07T00:00:00",
enddatetime: "2018-03-30T23:59:59",
rewards: [
{
rewardid: 756,
changetype: 0,
changepercent: 25,
applyind: 0,
rewardsmerch: [
{
rewardmerchid: 8435,
merchlevel: 5,
item: 114800196,
diffid: "BROWN_5534",
excludeind: 0
},
{
rewardmerchid: 8436,
merchlevel: 5,
item: 114800233,
diffid: "BROWN_5534",
excludeind: 0
},
{
rewardmerchid: 8437,
merchlevel: 5,
item: 114850290,
diffid: "BROWN_7343",
excludeind: 0}]}],conditions: [ ],locations: [{action: "INSERT",location: 5579346692},{action: "INSERT",location: 7761967237},{action: "INSERT",location: 8992251863},{action: "INSERT",location: 9953588522}]},{promoid: 3403,offerid: 877,desc: "Offer 877 Test",custdesc: "Offer 877 Test",levelcode: 0,typecode: 0,templateid: 3,startdatetime: "2018-02-07T00:00:00",enddatetime: "2018-03-30T23:59:59",rewards: [{rewardid: 757,changetype: 0,changepercent: 25,applyind: 0,rewardsmerch: [{rewardmerchid: 8438,merchlevel: 6,item: 114850388,excludeind: 0},{rewardmerchid: 8439,merchlevel: 4,item: 114850417,excludeind: 0},{rewardmerchid: 8440,merchlevel: 4,item: 114850425,excludeind: 0},{rewardmerchid: 8441,merchlevel: 6,item: 114850572,excludeind: 0},{rewardmerchid: 8442,merchlevel: 4,item: 114850417,excludeind: 0},{rewardmerchid: 8443,merchlevel: 6,item: 114850572,excludeind: 0},{rewardmerchid: 8444,merchlevel: 6,item: 114850441,excludeind: 0,canceldatetime: "2018-06-25T14:43:41.000000Z"}]}],conditions: [ ],locations: [{action: "INSERT",location: 5579346692},{action: "INSERT",location: 7761967237},{action: "INSERT",location: 9953588522}]},{promoid: 3403,offerid: 880,desc: "Offer 880 Test",custdesc: "Offer 880 Test",levelcode: 1,typecode: 1,templateid: 0,startdatetime: "2018-02-08T00:00:00",enddatetime: "2018-07-10T23:59:59",rewards: [{rewardid: 759,changetype: 1,changeamount: 20,applyind: 2,rewardsmerch: null}],conditions: [ ],locations: [{action: "DELETE",location: 5579346692},{action: "DELETE",location: 7761967237},{action: "DELETE",location: 9953588522}]}],hasMore: true,limit: 10000,count: 12,links: [ {.. } ]}
Get changes made to related items since a point in time.
GET ords/ocds/omnichannel/v2/item/relateditem
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the Organization Hierarchy node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how related item relationship has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA.
Important: This response has two levels of actions. This field only communicates the action of the relationship. |
| relationshipid | Unique identifier for each relationship. Data will always exist in this field. |
| item | Item for which the relationships are defined. This is the parent item in a related item relationship. Data will always exist in this field. |
| relationshiptype | Describes the type of relationship.Valid values include: CRSL (Cross Sell), SUBS (Substitution), UPSL (Up-sell). |
| mandatoryind | Indicates whether the relationship should be mandatory. For example, an item like a laptop may have a mandatory cross sell relationship. The related items could be different power cords for the US, UK, Mainland Europe, India, etc. When the laptop is sold, it should be mandatory that one of the related power cords also be selected. Generally, only cross sell relationships are mandatory. Substitution and upsell relationships can be defined as mandatory, but in those cases, the definition of mandatory is at the discretion of the client and generally means that substitution or upsell must, as business process, be offered to consumers. |
| relateditem | Item id of the related item. This is the item that should be Cross Sold, Substituted, or Up Sold when the item on the parent record is sold. |
| relateditemaction | Recommended action based on how the "related" item, in the related item relationship, has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA.
Important: This response has two levels of actions. This field communicates the action of the "relateditem" involved in the related item relationship. |
| startdate | From this date related item can be used on transactions. |
| enddate | Till this date related item can be used on transactions. A value of null means that it is effective forever. |
| priority | Applicable only in case of relationship type SUBS. In case of multiple related substitute items, this column could be used (optional) to define relative priority. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/relateditem?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"relationshipid": 1,
"item": "101500004",
"mandatoryind": "N",
"relationshiptype": "SUBS",
"relateditem": "100600003",
"startdate": "2014-12-17",
"enddate": "2014-12-31",
"priority": 1
},
{
"action": "INSERT",
"relationshipid": 402,
"item": "101500012",
"mandatoryind": "N",
"relationshiptype": "CRSL",
"relateditem": "101500004",
"relateditemaction": "DELETE",
"startdate": null,
"enddate": null,
"priority": null
},
{
"action": "INSERT",
"relationshipid": 402,
"item": "101500012"
"mandatoryind": "N",,
"relationshiptype": "CRSL",
"relateditem": "101500021",
"relateditemaction": "INSERT",
"startdate": null,
"enddate": null,
"priority": null
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get changes made to upc items since a point in time.
GET ords/ocds/omnichannel/v2/item/upc
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| itemlocation | The Organization Hierarchy Node id when requested by node, otherwise "ent" (Enterprise) is returned. |
| item | ID of item. Data will always be present in this field. |
| itemparent | ID identifies the item/group at the level above the item. This value must exist as an item in another row on the item_master table. |
| itemgrandparent | ID identifies the item/group two levels above the item. This value must exist as both an item and an item parent in another row on the item_master table. |
| itemlevel | Number indicating which of the three levels the item resides. The item level determines if the item stands alone or if it is part of a family of related items. The concept is best explained with typical (although not exhaustive) examples. Staple items generally have a item level = 1 UPCs for Staple items generally have an item level = 2 (and the staple item will be the UPCs parent item). Fashion styles generally have an item level = 1. Fashion skus generally have an item level = 2. If UPCs for fashion skus generally have an item level = 3. Valid values are 1, 2 and 3. This field will always have data. |
| tranlevel | Number indicating which of the three levels transactions occur for the items group. The transaction level is the level at which the items inventory is tracked in the system. The transaction level item will be inventoried, counted, transferred, shipped, etc. Only one level of the hierarchy of an item family may contain transaction level items. The concept is best explained with typical (although not exhaustive) examples. Staple items generally have a TranLevel = 1. UPCs for Staple items generally have an TranLevel = 1 (inventory txns occur at the staple sku level; sales of the item roll up to the parent staple sku). Fashion styles generally have a TranLevel = 2 (the style itself is not sold/inventoried). Fashion skus generally have an TranLevel = 2 (the fashion sku is sold/inventoried). If UPCs for fashion skus generally have an TranLevel = 2 (the fashion sku is sold/inventoried). There are some rare cases in vendor managed inventory where the TranLevel = 3. Valid values are 1, 2 and 3. This field will always have data. |
| inventoryind | This indicator is used to determine if inventory is held for the item/item family. Inventory is held for most items. However, inventory is not held (value = N) in some special cases, such as: Concession items (items that are sold by independent in location concessions), Consignment items (items are not owned by the retailer; financial and inventory processing occurs after the item is sold to a consumer), Containers sold then returned for deposit and some items that are transformed for sale. Valid values are Y and N. This field will always have data. |
| diff1level | This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id. |
| diff1type | This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table. |
| diff1 | Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz). |
| diff2level | This field will contain either ID or GROUP, based on whether the diff_2 is a group diff or a diff id. |
| diff2type | This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table. |
| diff2 | Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz). |
| diff3level | This field will contain either ID or GROUP, based on whether the diff_3 is a group diff or a diff id. |
| diff3type | This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table. |
| diff3 | Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz). |
| division | Number identifying the Division in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same division. This data is required |
| groupid | Number identifying the Group in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same group. This data is required |
| dept | Number identifying the department in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department. This data is required |
| class | Number identifying the class in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department and class. Class is not a unique ID (for example, every department can have a class 1). This data is required. |
| uniqueclass | Number identifying the class in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department and class. Class is not a unique ID (for example, every department can have a class 1). This data is required. |
| subclass | Number identifying the subclass in the merchandise hierarchy to which the item belongs. If the item has a parent, the parent and item will belong to the same department, class and subclass. Subclass is not a unique ID (for example, every department/class can have a subclass 1). This data is required. |
| uniquesubclass | Number uniquely identifying the subclass node which the item belongs to. Subclass is not unique ID the merchandise hierarchy. The combination of Dept/Class/Subclass is unique, but requires use of a composite key. The composite key is generally used in user interfaces. The unique ID can be used in back end processing or in systems that can not have a composite key for a node in the merchandise hierarchy. |
| description | Primary description of the item in the integration language of the system. This value is required. |
| localdescription | The local description of the item, when requesting by Organization Hierarchy Node and Hierarchy level is "STORE". This may be the same as the primary description of the item, a regional description of the item (for example, jimmies vs sprinkles in the US or roll vs bap vs cob vs bun in the UK), or a value in a local language (for example, Overlay dress true black knit at US stores vs Lagenkleid - Strick, tiefschwarz at stores in Germany). The intent is that this string is appropriate to print description on signage/receipts at this location. This will be null for all non-STORE Hierarchy levels. |
| merchandiseind | Indicates if the item is a merchandise item (Y, N). Merchandise items are generally physical items (things that must be shipped/received and of which there is an inventory). Non merchandise items are often items which do not have inventory. Common examples include extra fees for service (extended warranties, alterations) or endlessly available items (downloads, in app purchases of bonus content, subscriptions). All items, both merchandise and non-merchandise are exported from RMS. This value is required. |
| uintype | The unique identification number (UIN) used to identify the instances of the item at the location. |
| mfgrecretail | Manufacturers recommended retail price for the item. Used for informational purposes only. This field is stored in the primary currency. |
| originalunitretail | The original retail price of the item per unit. This field is stored in the primary currency. |
| catchweightind | Indicates whether the item should be weighed when it arrives at a location. Valid values for this field are Y and N. This field will always have data'; |
| itemservicelevel | Holds a value that restricts the type of shipment methods that RCOM can select for an item. |
| giftwrapind | This field will contain a value of Y if the item is eligible to be gift wrapped. If not explicitly defined, this field will default to N. This field will always have data records. |
| shipaloneind | This field will contain a value of Y if the item must be shipped alone to consumers. If not explicitly defined, this field will default to N. This field will always have data records. |
| standarduom | Unit of measure in which stock and or financials of the item is tracked at a corporate level. Unit of measure reference values may have to be manually synced between the systems as this is foundation data that is not currently bulk integrated out of Merch. This value is required. |
| productclassification | Product classification |
| xdiff1desc | When diff1level is ID, the description of the diff. When diff1level is GROUP, the description of the differentiator group. |
| xdiff2desc | When diff2level is ID, the description of the diff. When diff2level is GROUP, the description of the differentiator group. |
| xdiff3desc | When diff3level is ID, the description of the diff. When diff3level is GROUP, the description of the differentiator group. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/item/upc?nodeId=1&nodeLevel=CHAIN&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"itemlocation": "ent",
"item": "1000001",
"itemparent": "1",
"itemgrandparent": null,
"itemlevel": 2,
"tranlevel": 1,
"inventoryind": "Y",
"diff1level": null,
"diff1type": null,
"diff1": null,
"diff2level": null,
"diff2type": null,
"diff2": null,
"diff3level": null,
"diff3type": null,
"diff3": null,
"division": 1,
"groupid": 1,
"dept": 1,
"class": 1,
"uniqueclass": 1,
"subclass": 1,
"uniquesubclass": 1,
"description": "Below Transaction Item: 1000001",
"localdescription": null,
"merchandiseind": "Y",
"uintype": null,
"mfgrecretail": null,
"orginalunitretail": 12.94,
"catchweightind": "Y",
"itemservicelevel": null,
"giftwrapind": "Y",
"shipaloneind": "Y",
"standarduom": "EA",
"productclassification": null,
"xdiff1desc": null,
"xdiff2desc": null,
"xdiff3desc": null
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [ {.. } ]
}
Get changes made to retail stores since a point in time. Address fields are always derived from the primary Business (addr_type: 01) address.
GET ords/ocds/omnichannel/v2/location/retailstore
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| storeid | Unique ID of the store. |
| storename | Name of the store which, along with the store number, identifies the store. |
| storename10 | A ten character abbreviation of the store name. |
| manager | Name of the store manager. |
| phonenumber | Phone number for the store. |
| faxnumber | Fax number for the store. |
| Email address for the store. | |
| totalsqfeet | Total square footage of the store. |
| sellingsqfeet | Total square footage of the stores selling area. |
| currencycode | Currency code under which the store operates. |
| vatregion | Indicates whether or not Value Added Tax will be included in the retail prices for the store. Valid values are Y or N. |
| stockholdingind | Flag to indicate if store holds stock |
| integratedpos | Flag to indicate if pos system is integrated |
| contactname | Contact name for store |
| address1 | First line of the Primary Business address. When the store has a primary business address, this field will contain data. |
| address2 | Second line of the address. |
| address3 | Third line of the address. |
| city | Name of the city that is associated with the address. When the store has a primary business address, this field will contain data. |
| state | The state abbreviation for the address. |
| country | The ISO 3166-1 country code associated with the address. When the store has a primary business address, this field will contain data. |
| postalcode | Zip code for the address. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/location/retailstore?nodeId=1&nodeLevel=CHAIN&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"storeid": 2689,
"storename": "RMS Store",
"storename10": "STORE",
"manager": "Mr. Jones",
"contactname": "Sally Smith" "phonenumber": "123456",
"faxnumber": "123456",
"email": "example@mail.com",
"totalsqfeet":20000
"selllingsqfeet":18000
"currencycode": "USD",
"vatregion": 1000,
"address1": "addr",
"address2": null,
"address3": null,
"city": "mpls",
"state": "MN",
"country": "US",
"postalcode": "55345"
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [ {.. } ]
}
Get changes made to warehouses since a point in time. Address fields are always derived from the primary Business (addr_type: 01) address.
GET ords/ocds/omnichannel/v2/location/warehouse
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| warehouseid | Number which uniquely identifies the warehouse. The wh table stores all warehouses in the system. Both virtual and physical warehouses will be stored on this table. The addition of the new column, physical_wh, helps determine which warehouses are physical and which are virtual. All physical warehouses will have a physical_wh column value equal to their wh number. Virtual warehouses will have a valid physical warehouse in this column. |
| warehousename | Name of the warehouse which, along with the warehouse number, identifies the warehouse. |
| whnamesecondary | Secondary name of the warehouse. |
| contactname | Name of the contact at this address |
| phonenumber | Phone number of the contact person |
| faxnumber | Fax number of the contact person |
| Email address of the partner or suppliers representative contact. | |
| currencycode | Currency code under which the warehouse operates. |
| physicalwh | The number of the physical warehouse that is assigned to the virtual warehouse. |
| vatregion | Vat Region in which warehouse is located |
| orghiertype | Organization type that will be used in reporting purposes for the warehouse. The type comes from the organizational hierarchy. Valid values are:1 = Company 10 = Chain 20 = Area 30 = Region 40 = District 50 = Store |
| orghiervalue | Code associated with the specific organizational hierarchy type. Valid values include the company number, chain number, area number, etc. |
| ordentitytype | Type of rganizational entity |
| channelid | Channel for which the virtual warehouse will be assigned. |
| channelname | Name of the channel. |
| address1 | Primary Business address. When the store has a primary business address, this field will contain data. |
| address2 | Second line of the address. |
| address3 | Third line of the address. |
| city | Name of the city that is associated with the address. When the store has a primary business address, this field will contain data. |
| state | State abbreviation for the address. |
| country | The ISO 3166-1 country code associated with the address. When the store has a primary business address, this field will contain data. |
| postalcode | Zip code for the address. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/location/warehouse?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"warehouseid": 1,
"type": "physical",
"warehousename": "Warehouse #1",
"whnamesecondary": "Physical Warehouse 1",
"contactname": "Contact 2",
"phonenumber": "xxx-xxx-xxxx",
"faxnumber": "xxx-xxx-xxxx",
"email": "email@example.com",
"currencycode": "USD",
"physicalwh": 1,
"vatregion": 1000,
"orghiertype": null,
"orghiervalue": null,
"orgentitytype": "R",
"channelid": null,
"channelname": null,
"address1": "2 Main Street",
"address2": "Unit 0",
"address3": "Box 1-2",
"city": "Minneapolis",
"state": "MN",
"country": "US",
"postalcode": "55407"
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [ {.. } ]
}
Get changes made to the merchandise hierarchy since a point in time. The merchandise hierarchy enables the grouping of items by Division, Group, Department, Class and Subclass.
GET ords/ocds/omnichannel/v2/merchhier
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| nodeid | This information identifies the node of the merchanidise hierarchy that is described by this record. This field can not be null. HierarchyNodeId is only unique within an HierarchyLevel (meaning it is possible, for example, that there is both a DIVISION 1 and a GROUP 1 in the full merchandise hierarchy). |
| hierarchylevel | Name of the merchandise hierarchy entity. Description data is only sent in the primary integration language of the system. |
| nodename | Level of the merchandise hierarchy above the current node. Both ParentLevel and ParentId are should be evaluated to correctly traverse the hierarchy |
| parentlevel | Level of the merchandise hierarchy above the current node. Both ParentLevel and ParentId are should be evaluated to correctly traverse the hierarchy |
| parentnodeid | Id of the level of the merchandise hierarchy above the current node. Both ParentLevel and ParentNodeId are should be evaluated to correctly traverse the hierarchy. |
| merchdisplayid | Contains a code which indicates whether items in this department are normal merchandise, consignment stock or concession items. |
| buyer | Buyer for the node |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/merchhier?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"nodeid": 4,
"hierarchylevel": "SUBCLASS",
"nodename": "Mens RMS 15.0",
"parentlevel": "CLASS",
"parentnodeid": 4
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [ {.. } ]
}
Get changes made to the organizational hierarchy since a point in time. The organizational hierarchy describes the operational structure of a company
GET ords/ocds/omnichannel/v2/orghier
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| hierarchylevel | This information identifies the level of the organizational hierarchy that is described by this record.Value is always COMPANY, CHAIN, AREA, REGION, DISTRICT, STORE or WAREHOUSE. This field can not be null. |
| hierarchynodeid | This information identifies the node of the organizational hierarchy that is described by this record. This field can not be null. HierarchyNodeId is only unique within an HierarchyLevel (meaning it is possible, for example, that there is both a DISTRICT 1 and a REGION 1 in the full organizational hierarchy). |
| hierarchynodename | Name of the organizational hierarchy entity. This field can not be null. Description data is only sent in the primary integration language of the system. |
| parentlevel | This information identifies the parent level of the organizational hierarchy that is described by this record' |
| parentid | This information identifies the id of parent organizational hierarchy. |
| mgrname | Name of manager for the node. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/orghier?nodeId=1&nodeLevel=COMPANY&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"hierarchylevel": "CHAIN",
"hierarchynodeid": 1,
"hierarchynodename": "Chain_1",
"parentlevel": "COMPANY",
"parentid": 1,
"mgrname": null,
"stockholding": null,
"integratedpos": null
},
{
"action": "INSERT",
"hierarchylevel": "COMPANY",
"hierarchynodeid": 1,
"hierarchynodename": "Company_1",
"parentlevel": null,
"parentid": null,
"mgrname": null,
"stockholding": null,
"integratedpos": null
},
{
"action": "INSERT",
"hierarchylevel": "DISTRICT",
"hierarchynodeid": 1,
"hierarchynodename": "District_1",
"parentlevel": "REGION",
"parentid": 1,
"mgrname": null,
"stockholding": null,
"integratedpos": null
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get entire branch of the organizational hierarchy beginning with a specified node. This resource returns the latest state of the organizational hierarchy.
GET ords/ocds/omnichannel/v2/orghier/descendant
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| nodelevel |
|
Request data for a single node in the Organization Hierarchy. Must be used with nodeId to identify the node. | Yes | Query | String |
| nodeid | 0 .. n | Request data for a single node in the Organization Hierarchy. Must be used with node level to identify the node. | Yes | Query | Integer |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| hierarchylevel | This information identifies the level of the organizational hierarchy that is described by this record.Value is always COMPANY, CHAIN, AREA, REGION, DISTRICT, STORE or WAREHOUSE. This field can not be null. |
| hierarchynodeid | This information identifies the node of the organizational hierarchy that is described by this record. This field can not be null. HierarchyNodeId is only unique within an HierarchyLevel (meaning it is possible, for example, that there is both a DISTRICT 1 and a REGION 1 in the full organizational hierarchy). |
| hierarchynodename | Name of the organizational hierarchy entity. This field can not be null. Description data is only sent in the primary integration language of the system. |
| parentlevel | This information identifies the parent level of the organizational hierarchy that is described by this record' |
| parentid | This information identifies the id of parent organizational hierarchy. |
| levelorder | Sequence for level |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/omnichannel/v2/orghier/descendant?nodeId=1&nodeLevel=COMPANY
{
"items": [
{
"hierarchylevel": "CHAIN",
"hierarchynodeid": 1,
"hierarchynodename": "Chain_1",
"parentlevel": "COMPANY",
"parentid": 1,
"levelorder": 10
},
{
"hierarchylevel": "REGION",
"hierarchynodeid": 1,
"hierarchynodename": "Region_1",
"parentlevel": "CHAIN",
"parentid": 1,
"levelorder": 30
},
{
"hierarchylevel": "REGION",
"hierarchynodeid": 2,
"hierarchynodename": "Region_2",
"parentlevel": "CHAIN",
"parentid": 1,
"levelorder": 30
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
Get the date bulk data arrived into the system. The refresh date can be compared to the SINCE request parameter, in REST calls to foundation data resources, to determine if response data represents "initial load" or an "incremental change".
GET ords/ocds/omnichannel/v2/refreshdate
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| entitytype |
|
Request refresh date for a single entity. This parameter is optional; when not used, refreshdates for all entities are returned. | Yes | Query | Integer |
| limit | Number | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| entity | The system entity. Each entity value correlates with one of the foundation data REST resources provided by this API |
| refreshdate | The timestamp data, for an entity, was initially loaded into system. |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/omnidevpdb/omnichannel/v2/refreshdate
https://{host}:{port}/ords/omnidevpdb/omnichannel/v2/refreshdate?entitytype=merchhier
{
"items": [
{
"entity": "Item",
"refreshdate": "2020-05-01T13:14:25.286000000-05:00"
}
],
"hasMore": false,
"limit": 10000,
"count": 1,
"links": [ {.. } ]
}
Get changes made to vat region codes since a point in time.
GET ords/ocds/omnichannel/v2/vat
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| since | UTC ISO-8601 Date and Time | Request data changed since a specific point in time. Use is optional, if not used then changes since 00:00:00 (UTC) on January 1, 1970 will be returned. | Yes | Query | Timestamp |
| before | UTC ISO-8601 Date and Time | Request data changed before a specific point in time. This parameter provides a mechanism where by callers can exclude data-changes occurring at the present time to avoid getting partial changes due to in-flight changes. | Yes | Query | Timestamp |
| limit | 0 .. n | Limit response size to a fixed number of data items to control paging of result data. Use is optional. If not used then a default limit is used. | Yes | Query | Integer |
| offsetkey | generated | Provides the offset information for the next page. This is machine generated and should not be altered | Yes | Query | String |
| Field | Description |
| action | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| vatregion | Identifier for the VAT Region |
| vatregionname | Name of the VAT Region |
| vatcode | VAT Code identifier |
| vatcodedesc | Description of the VAT Code |
| activedate | Active date for the VAT Tax |
| enddate | End date for the VAR Tax |
Content-Type: application/json
Usage:
https://{host}:{port}/ords/ocds/ocds/v2/vat?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
{
"items": [
{
"action": "INSERT",
"vatregion": 1000,
"vatregionname": "Vat Region 1000",
"vatcode": "1",
"vatcodedesc": "Vat Code 1",
"activedate": "2020-01-10T12:26:57",
"enddate": null
},
{
"action": "INSERT",
"vatregion": 1000,
"vatregionname": "Vat Region 1000",
"vatcode": "10",
"vatcodedesc": "Vat Code 10",
"activedate": "2019-11-26T12:26:57",
"enddate": null
},
{
"action": "INSERT",
"vatregion": 1000,
"vatregionname": "Vat Region 1000",
"vatcode": "100",
"vatcodedesc": "Vat Code 100",
"activedate": "2020-01-27T12:26:57",
"enddate": null
}
],
"hasMore": true,
"limit": 3,
"count": 3,
"links": [ {.. } ]
}
