REST Order OrderItem OrderItemProperty
Provides find, create, update and delete for order item properties.
Get all order item propertys for one order item by its order item id.
/rest/orders/items/{orderItemId}/properties
Parameters
Field |
Type |
Description |
orderItemId |
Int |
The order item ID of the order item property instance to be loaded |
Success 200
Response is a List
Field |
Type |
Description |
id |
Int |
The ID of the order item property. |
orderItemId |
Int |
The ID of the order item that the property belongs to. |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
|
value |
String |
The value of the property. The value depends on type. |
createdAt |
String|\Carbon |
The date that the property was created. |
updatedAt |
String|\Carbon |
The date that the property was last updated. |
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Get an order item property by order item ID and order property type ID.
/rest/orders/items/{orderItemId}/properties/{typeId}
Parameters
Field |
Type |
Description |
orderItemId |
Int |
The order item ID of the order item property instance to be loaded |
typeId |
Int |
The order property type ID of the order item property instance to be loaded |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order item property. |
orderItemId |
Int |
The ID of the order item that the property belongs to. |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
|
value |
String |
The value of the property. The value depends on type. |
createdAt |
String|\Carbon |
The date that the property was created. |
updatedAt |
String|\Carbon |
The date that the property was last updated. |
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Create an order item property by order item ID and order property type ID.
/rest/orders/items/{orderItemId}/properties/{typeId}
Parameters
Field |
Type |
Description |
orderItemId |
Int |
The order item ID of the order item property instance to be created |
typeId |
Int |
The order property type ID of the order item property instance to be created |
Request
Field |
Type |
Description |
orderItemId |
Int |
The ID of the order item that the property belongs to. optional required with typeId |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
optional required with orderItemId |
value |
String |
The value of the property. The value depends on type. required |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order item property. |
orderItemId |
Int |
The ID of the order item that the property belongs to. |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
|
value |
String |
The value of the property. The value depends on type. |
createdAt |
String|\Carbon |
The date that the property was created. |
updatedAt |
String|\Carbon |
The date that the property was last updated. |
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Update an order item property by order item ID and order property type ID.
/rest/orders/items/{orderItemId}/properties/{typeId}
Parameters
Field |
Type |
Description |
orderItemId |
Int |
The order item ID of the order item property instance to be updated |
typeId |
Int |
The order property type ID of the order item property instance to be updated |
Request
Field |
Type |
Description |
orderItemId |
Int |
The ID of the order item that the property belongs to. optional |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
optional |
value |
String |
The value of the property. The value depends on type. |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order item property. |
orderItemId |
Int |
The ID of the order item that the property belongs to. |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
|
value |
String |
The value of the property. The value depends on type. |
createdAt |
String|\Carbon |
The date that the property was created. |
updatedAt |
String|\Carbon |
The date that the property was last updated. |
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Delete an order item property by order item ID and order property type ID.
/rest/orders/items/{orderItemId}/properties/{typeId}
Parameters
Field |
Type |
Description |
orderItemId |
Int |
The order item ID of the order item property instance to be deleted |
typeId |
Int |
The order property type ID of the order item property instance to be deleted |
Success 200
This call does not have a response output.
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Get an order item property by ID.
/rest/orders/items/properties/{id}
Parameters
Field |
Type |
Description |
id |
Int |
The ID of the order item property instance to be loaded. |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order item property. |
orderItemId |
Int |
The ID of the order item that the property belongs to. |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
|
value |
String |
The value of the property. The value depends on type. |
createdAt |
String|\Carbon |
The date that the property was created. |
updatedAt |
String|\Carbon |
The date that the property was last updated. |
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Create an order item property.
/rest/orders/items/properties
Request
Field |
Type |
Description |
orderItemId |
Int |
The ID of the order item that the property belongs to. optional required with typeId |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
optional required with orderItemId |
value |
String |
The value of the property. The value depends on type. required |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order item property. |
orderItemId |
Int |
The ID of the order item that the property belongs to. |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
|
value |
String |
The value of the property. The value depends on type. |
createdAt |
String|\Carbon |
The date that the property was created. |
updatedAt |
String|\Carbon |
The date that the property was last updated. |
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Update an order item property by ID.
/rest/orders/items/properties/{id}
Parameters
Field |
Type |
Description |
id |
Int |
The ID of the order item property instance to be updated. |
Request
Field |
Type |
Description |
orderItemId |
Int |
The ID of the order item that the property belongs to. optional |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
optional |
value |
String |
The value of the property. The value depends on type. |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order item property. |
orderItemId |
Int |
The ID of the order item that the property belongs to. |
typeId |
Int |
The ID of the property type.
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- ORIGINAL_WAREHOUSE = 20
- ORIGINAL_QUANTITY = 21
- CATEGORY_ID = 22
- MARKET_FEE = 23
- STOCK_REVERSING = 24
- DISPUTE_STATUS = 25
- NO_CHANGE_BY_CONTACT = 26
- SIZE = 29
- LOCATION_RESERVED = 30
- EXTERNAL_SHIPMENT_ITEM_ID = 31
- PARTIAL_SHIPPING_COSTS = 32
- MAIN_DOCUMENT_NUMBER = 33
- SALES_TAX_ID_NUMBER = 34
- RETURNS_REASON = 35
- RETURNS_ITEM_STATUS = 36
- FULFILLMENT_CENTER_ID = 37
- FULFILLMENT_CENTER_COUNTRY_ISO = 38
- REORDER_ITEM_ID = 39
- LISTING_TYPE = 40
- SOLD_COUPON_CODE = 46
- ORDER_ITEM_STATE = 48
|
value |
String |
The value of the property. The value depends on type. |
createdAt |
String|\Carbon |
The date that the property was created. |
updatedAt |
String|\Carbon |
The date that the property was last updated. |
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Delete an order item property by ID.
/rest/orders/items/properties/{id}
Parameters
Field |
Type |
Description |
id |
Int |
The ID of the order item property instance to be deleted. |
Success 200
This call does not have a response output.
Errors 4xx
Code |
Exception |
Description |
401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |