| Oracle® Retail Omnichannel Cloud Data Service Implementation Guide Release 19.0.000 F25864-02 |
|
 Previous |
| Oracle® Retail Omnichannel Cloud Data Service Implementation Guide Release 19.0.000 F25864-02 |
|
Previous |
This chapter describes the REST Web Service API
Get OCDS log entries for diagnostic purposes
GET ords/{system}/omnichannel/v1/admin/log
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
Get OCDS log entries for diagnostic purposes
GET ords/{system}/omnichannel/v1/admin/version
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
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/v1/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 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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. |
Get the changes made to Diff Groups since a point in time.
GET ords/{system}/omnichannel/v1/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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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 | This field will hold a unique id for the diff that is a member of this diff group. Data will always be present in this field. |
Get the changes made to Future Inventory positions since a point in time.
GET ords/{system}/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 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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 sellable and orderable transaction level item whose future inventory position is described. The item must be backorderable. |
| onorderquantity | Open order quantity for the item at all locations that are flagged as customer order locations and backorderable for the item. It is calculated as ordered quantity - allocated quantity for allocations to non-customer order locations. |
| receivedquantity | Received order quantity for the item at all locations. |
| backorderquantity | Back order quantity for the item at all locations that are flagged as customer order locations and backorderable for the item. |
Get the changes made to Available Store Inventory since a point in time.
GET ords/{system}/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 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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 | Item whose current inventory position described. |
| location | Location at which the item has inventory. |
| loctype | Type of location. S - store. |
| availablequantity | Available quantity of the item at the location. This qty is calculated by subtracting transfer reserved qty, customer reserved qty, non sellable inventory and RTV from stock on hand (e.g. current available inventory = stock on hand - (tsf reserved + customer reserved + non sellable + RTV qty)). Available inventory is in the standard unit of measure. For supplier records, -1 will be selected to indicate infinite inventory. |
| stockonhand | Current stock on hand for the item. |
| standarduom | Unit of measure in which stock of the item is tracked at a corporate level. |
Get the changes made to Warehouse Inventory since a point in time.
GET ords/{system}/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 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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 | Item whose current inventory position described. |
| location | Warehouse at which the item has inventory. This is always a virtual warehouse. |
| loctype | Type of location. W represents the virtual warehouse. |
| availablequantity | Available quantity of the item at the location. This qty is calculated by subtracting transfer reserved qty, customer reserved qty, non sellable inventory and RTV from stock on hand (e.g. current available inventory = stock on hand - (tsf reserved + customer reserved + non sellable + RTV qty)). Available inventory is in the standard unit of measure. |
| stockonhand | Current stock on hand for the item. |
| standarduom | Unit of measure in which stock of the item is tracked at a corporate level. |
| physicalwarehouse | This column will contain the number of the physical warehouse that is assigned to the virtual warehouse. It will only contain a value when location is a warehouse. |
Get changes made to items since a point in time.
GET ords/{system}/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 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 nodelevel 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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 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 (e.g. 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 (e.g. 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 (e.g. 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 (e.g. jimmies vs sprinkles in the US or roll vs bap vs cob vs bun in the UK), or a value in a local language (e.g. 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. |
| 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. |
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/{system}/omnichannel/v1/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 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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. |
| 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. |
Content-Type: application/json
Sample URL:
https://{host}:{port}/ords/{system}/omnichannel/v1/item/dimensiontype?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/{system}/omnichannel/v1/item/dimensiontype?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
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/{system}/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 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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. |
| 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, e.g. S, M, L, etc. |
| description | The text description of the value code (Diff). |
Content-Type: application/json
Sample URL:
https://{host}:{port}/ords/{system}/omnichannel/v2/item/dimensionvalue?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/{system}/omnichannel/v2/item/dimensionvalue?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
Get changes made to item images since a point in time.
GET ords/{system}/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 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 nodelevel 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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. |
| 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
Sample URL:
https://{host}:{port}/ords/{system}/omnichannel/v2/item/image?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/{system}/omnichannel/v2/item/image?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
Get changes made to item locations since a point in time.
GET ords/{system}/omnichannel/v2/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 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 nodelevel 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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. |
| loc_type | 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 (e.g. jimmies vs sprinkles in the US or roll vs bap vs cob vs bun in the UK), or a value in a local language (e.g. 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 | Indicates if the item can be returned to the location |
| backorderind | Indicates if the item can be back ordered to the location |
| merchandiseind | Indicates if the item is a merchandise item. |
| clearanceind | Indicates if item is on clearance at the store. |
| 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
Sample URL:
https://{host}:{port}/ords/{system}/omnichannel/v2/item/itemlocation?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/{system}/omnichannel/v2/item/itemlocation?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
Get changes made to item prices, by pricetype, since a point in time.
GET ords/{system}/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 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 nodelevel 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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. |
| location | Location identifier for item price |
| loctype | Location type |
| item | Item identifier |
| pricetype | INITIAL, REGULAR, CLEARANCE |
| price | item price |
| effective | Date time when change becomes effective |
| 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 |
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/{system}/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 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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 |
| 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. |
| 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 |
| startdatetime | Starting date time for the offer |
| enddatetime | Ending date time for the offer |
| rewards | Rewards associated with the offer |
| rewards.rewardsid | 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
Sample URL:
https://{host}:{port}/ords/{system}/omnichannel/v2/item/promotion?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/{system}/omnichannel/v2/item/promotion?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
Get changes made to related items since a point in time.
GET ords/{system}/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 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 nodelevel 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 | calculated | Request paged data beginning at a specific offset key. Use is optional. If not used then entire first page of data is returned. Calculated value is obtained from the "next" link of the prior page. | Yes | Query | Integer |
| 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. |
| 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. |
| relationshiptype | Describes the type of relationship.Valid values include: CRSL (Cross Sell), SUBS (Substitution), UPSL (Up-sell). |
| 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. |
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/{system}/omnichannel/v1/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 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 nodelevel 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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. |
| contactname | Name of the contact at this address |
| 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. |
| 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. |
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/{system}/omnichannel/v1/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 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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. |
| 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. |
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/{system}/omnichannel/v1/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 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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 the node of the merchandise 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 | Holds the merchandise hierarchy id for division, group, department, class, and subclass. |
Content-Type: application/json
Sample URL:
https://{host}:{port}/ords/{system}/omnichannel/v1/merchhier?since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
https://{host}:{port}/ords/{system}/omnichannel/v1/merchhier?nodeId=5111&nodeLevel=STORE&since=2018-01-23T16:26:41.485Z&before=2018-06-23T16:26:41.485Z
Get available resources in the specified versions of the API.
GET ords/{system}/omnichannel/v1/metadata-catalog
| Parameter | Value | Description | Optional | Parameter Type | Data Type |
|---|---|---|---|---|---|
| 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 |
| offset | Number | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
Get changes made to the organizational hierarchy since a point in time. The organizational hierarchy describes the operational structure of a company
GET ords/{system}/omnichannel/v1/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 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 nodelevel 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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 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 | NA |
Get entire branch of the organizational hierarchy beginning with a specified node. This resource returns the latest state of the organizational hierarchy.
GET ords/{system}/omnichannel/v1/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 nodelevel 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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 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. |
Get the date bulk data arrived into the system. The refreshdate 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/{system}/omnichannel/v1/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 |
| offset | Number | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
Get changes made to the VAT since a point in time. The VAT describes a VAT code.
GET ords/{system}/omnichannel/v1/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 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 |
| offset | 0 .. n | Request paged data beginning at a specific offset. Use is optional. If not used then entire first page of data is returned. | Yes | Query | Integer |
| 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 | The identifying number for the VAT region. |
| vatregionname | The name associated with the VAT region. |
| vatcode | The alphanumeric identification for the VAT code. |
| vatcodedesc | The description identifying the VAT code. |
| activedate | The active date on which the VAT rate becomes active. |
| vatrate | The rate associated with the given VAT code. |
| enddate | The date on which the VAT rate is no longer active. |
