Order Item API
Essential knowledge
Author:
Fluent Commerce
Changed on:
3 July 2024
Overview
An Order Item is the SKU purchased by the customer on the Retailer's online store. There can be one or many Order Items within an Order. Each order item has an associated quantity and paid price.
Key points
- Order Item Properties
- What you can do with Order Item
- Response on Failures
Order Item Properties
Below are the properties available in the Order Item object which can be updated and retrieved through the APIs in this document.
1. orderRef
Type: String
Description: { "orderRef" : "example" } The unique reference provided by the retailer.
2. createdOn
Type: DateTime
Description: { "createdOn" : "2016-05-06T23:41:12.242Z" } Date/time when the Order was created.
3. items
Type: Array
Description:
1{ "skuId" : "397625" }
2
3{ "skuRef" : "FX141123TPRT-1-2" }
4
5{ "productId" : "21231231" }
6
7{ "requestedQty" : "1" }
8
9{ "skuPrice" : "59.99" }
10
11{ "skuTaxPrice" : "null" }
12
13{ "totalPrice" : "59.99" }
14
15{ "totalPrice" : "null" }
16
17{ "taxType" : "null" }
18
19{ "currency" : "AUD" }
20
21{ "imageUrlRef" : "http://demandware.edgesuite.net/aazi_dev/on/demandware.static/Sites-seed-au-Site/-/default/dwa7384063/images/noimagemedium.png" }
22
23{ "skuResponse" : [array] }Language: java
Name: Description
Description:
[Warning: empty required content area]An array of order item(s)
- skuId (String) : The unique identifier assigned to the SKU by Fluent Commerce.
- skuRef (String) : The unique SKU reference or code provided by the retailer.
- productId (String) : The unique identifier assigned by Fluent Commerce.
- requestedQty (Integer) : The total quantity assigned to the fulfilment.
- skuPrice (Double) : The amount paid for the unit item excluding tax.
- skuTaxPrice (Double) : The amount of tax paid for the unit item.
- totalPrice (Double) : The total amount paid for the line item excluding tax.
- totalTaxPrice (Double) : The total amount of tax paid for the line item.
- taxType (String) : The type of tax is associated with the Order Item. Allowed values are:
- GST,
- VAT,
- EXCLTAX
- currency (String) : The type of currency used to pay for the unit, this should be provided if the amount is received, 3 letter ISO currency code.
- imageUrlRef (String) : Can be used to provide the Image URL so that order items have an image displayed.
- skuResponse (Object[skuResponse]) : The object with the SKU details.
4. skuResponse
Type: Object
1{ "skuRef" : "FX141123TPRT-1-2" }
2
3{ "productRef" : "9083122" }
4
5{ "name" : "Asymmetrical Sweater" }
6
7{ "status" : "ACTIVE" }
8
9{ "imageUrlRef" : "http://imageurl.com/noimagemedium.png" }
10
11{ "retailerId" : "197" }
12
13{ "prices" : [array] }
14
15{ "categories" : [array] }
16
17{ "attributes" : [array] }
18
19{ "references" : [array] }
20
21{ "categoryRef" : "83" }
22
23{ "categoryId" : "750" }Language: java
Name: Description
Description:
[Warning: empty required content area]An array of SKUs
- skuRef (String) : The unique SKU reference or code provided by the retailer..
- productRef (String) : The unique product reference or code provided by the retailer.
- name (String) : Product name.
- status (Integer) : The SKU status. Possible values are:
- ACTIVE'
- INACTIVE
- UNKNOWN
- imageUrlRef (String) : Can be used to provide the Image URL so that order items have an image displayed.
- retailerId (string) : The retailer identifier assigned by Fluent Commerce.
- prices (array) : Array of prices associated with the SKU.
- categories (array[categorySummary]) : Array of categories associated with the SKU.
- attributes (array) : Array of attributes associated with the SKU.
- references (array) : Array of SKU references. e.g.: EAN, MPN numbers. One SKU can have multiple references.
- categoryRef (String) : The unique category reference or code provided by the retailer.
- categoryId (String) : The unique identifier assigned to the category by Fluent Commerce.
5. price
Type: Array
1{ "type" : "CURRENT" }
2
3{ "value" : "89.95" }Language: java
Name: Description
Description:
[Warning: empty required content area]An array of prices associated with the SKU
- currency (String) : The type of currency used to pay for the unit, this should be provided if the amount is received, 3 letter ISO currency code.
- type (String) : The price type. Possible values are:
- CURRENT
- ORIGINAL
- value (String) : The associated price
6. categorySummary
Type: Array
Description:
1{ "categoryId" : "750" }
2
3{ "name" : "W ACTIVEWEAR" }
4
5{ "retailerId" : "197" }Language: java
Name: Description
Description:
[Warning: empty required content area]An array of categories associated with the SKU
- categoryRef (String) : The unique category reference or code provided by the retailer.
- categoryId (String) : The unique identifier assigned to the category by Fluent Commerce.
- name (string) : The category name.
- retailerId (long) : The retailer identifier assigned by Fluent Commerce
7. attributes
Type: Array
Description:
1"attributes": [
2 {
3 "name": "SIZE_DESC",
4 "value": "S",
5 "type": "STRING"
6 },
7 {
8 "name": "SIZE_NUMBER",
9 "value": "S",
10 "type": "INTEGER"
11 },
12 {
13 "name": "COLOUR_DESC",
14 "value": "BLACK",
15 "type": "STRING"
16 },
17 {
18 "name": "COLOUR_NUMBER",
19 "value": "59",
20 "type": "INTEGER"
21 }
22 ]Language: java
Name: Description
Description:
[Warning: empty required content area]Array of attributes. Attributes are used to provide additional information about the order item.
- name (String) : Indicates specific SKU attribute e.g. brand.
- type (String/Integer) : Data type of specific SKU attribute. Possible values are:
- STRING
- INTEGER
- value (String) : Value of SKU attribute.
8. references
Type: Array
Description:
1{ "value": "9346917673328" }Language: java
Name: Description
Description:
[Warning: empty required content area]Array of SKU references. e.g.: EAN, MPN numbers. Once SKU can have multiple references
- type (String) :
- value (String) :
What you can do with Order Item
View Order Item(s)
Retrieve all the order items associated with an order
GET:
`/api/v4.1/order/{orderId}/item`Request and response
Request parameters and sample
Order Request
`/api/v4.1/order/{orderId}/item`Example request /api/v4.1/order/4124141/item
Response Parameters and sample
1orderItemResponse {
2 createdOn (string),
3 orderRef (string),
4 items (array),
5 attributes (array)
6
7 items [{
8 skuId (string),
9 skuRef (string),
10 productId (string),
11 requestedQty (string),
12 skuPrice (double),
13 skuTaxPrice (double),
14 totalPrice (double),
15 totalTaxPrice (double),
16 taxType (string),
17 currency (string),
18 imageUrlRef (string),
19 skuResponse (object[skuResponse)
20 }]
21
22 skuResponse {
23 skuId (string),
24 skuRef (string),
25 productRef (string),
26 name (string),
27 status (string),
28 imageUrlRef (string),
29 retailerId (string),
30 prices (array)
31 }
32
33 prices {
34
35 currency (string) = 'AUD', 'NZD',
36 type (string) = 'CURRENT', 'ORIGINAL',
37 value (double)
38 }
39
40 categories (array[categorySummary]),
41
42 categorySummary {
43
44 categoryRef (string),
45 categoryId (string),
46 name (string),
47 retailerId (long)
48 }
49
50 attributes {
51
52 name (string),
53 type (string),
54 value (string)
55 }
56
57``references (array)``
58
59 references {
60
61 type (string),
62 value (string)
63 }
64
65}
66Language: java
Name: Order Item response
Description:
[Warning: empty required content area]1{
2 "orderRef": "SEEDAU00001601",
3 "createdOn": "2015-11-16T02:10:22.000+0000",
4 "items": [
5 {
6 "imageUrlRef": "http://demandware.edgesuite.net/aazi_dev/on/demandware.static/Sites-seed-au-Site/-/default/dwa7384063/images/noimagemedium.png",
7 "requestedQty": 1,
8 "skuId": "397625",
9 "skuRef": "9083122-59-S-se",
10 "skuPrice": 59.95,
11 "skuTaxPrice": 5.45,
12 "totalPrice": 59.95,
13 "totalTaxPrice": 5.45,
14 "taxType": null,
15 "currency": "AUD",
16 "skuResponse": {
17 "skuId": 397625,
18 "skuRef": "9083122-59-S-se",
19 "productRef": "9083122",
20 "name": "Asymmetrical Sweater",
21 "status": "ACTIVE",
22 "prices": [
23 {
24 "type": "UNIT_PRICE",
25 "value": 59.95,
26 "currency": "AUD"
27 },
28 {
29 "type": "ORIGINAL_PRICE",
30 "value": 59.95,
31 "currency": "AUD"
32 }
33 ],
34 "attributes": [
35 {
36 "name": "SIZE_DESC",
37 "value": "S",
38 "type": "STRING"
39 },
40 {
41 "name": "SIZE_NUMBER",
42 "value": "S",
43 "type": "INTEGER"
44 },
45 {
46 "name": "COLOUR_DESC",
47 "value": "BLACK",
48 "type": "STRING"
49 },
50 {
51 "name": "COLOUR_NUMBER",
52 "value": "59",
53 "type": "INTEGER"
54 }
55 ],
56 "references": [
57 {
58 "type": "BARCODE",
59 "value": "9346917673328"
60 }
61 ],
62 "retailerId": 433,
63 "imageUrlRef": "http://demandware.edgesuite.net/aazi_dev/on/demandware.static/Sites-seed-au-Site/-/default/dwa7384063/images/noimagemedium.png",
64 "categories": [
65 {
66 "categoryId": "750",
67 "categoryRef": "83",
68 "name": "W ACTIVEWEAR",
69 "retailerId": 433
70 }
71 ]
72 }
73 }
74 ]
75}Language: json
Name: Example request
Description:
[Warning: empty required content area]Response on Failures
NAME | TYPE | DESCRIPTION |
error | Array | Array of errors |
message | String | Additional information on the code Unauthorized | Bad Request | Forbidden | Not Found | Status 500 Error |
code | String | Status Code for the above messages 401 | 400 | 403 | 404 | 500 |
