REST Order OrderProperty
Create, update, get, list or delete order property types as well as order properties. Order properties contain information that are additional to an order. Each property has a type and each type can have several names, but only one name per language. An order can only have one property of each property type.
List properties of an order
Lists properties of an order. The ID of the order must be specified.
/rest/orders/{orderId}/properties/{typeId?}
Parameters
Field |
Type |
Description |
orderId |
Int |
The ID of the order |
typeId |
Int |
The property type ID |
Success 200
Response is a List
Field |
Type |
Description |
id |
Int |
The ID of the order property |
orderId |
Int |
The ID of the order that the property belongs to |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
|
value |
String |
The value of the property. The value depends on the type. |
[{"orderId":1001,"typeId":4,"value":"illum","createdAt":"2018-09-30T10:33:54+02:00","updatedAt":"2018-11-01T01:23:26+01:00"},{"orderId":1001,"typeId":11,"value":"sed","createdAt":"2018-08-08T01:09:20+02:00","updatedAt":"2018-12-17T19:25:18+01:00"}]
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 a property for an order
Creates a property and attaches it to an order. The ID of the order must be specified.
/rest/orders/{orderId}/properties
Request
Field |
Type |
Description |
orderId |
Int |
The ID of the order that the property belongs to required |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
required |
value |
String |
The value of the property. The value depends on the type. required |
{"typeId":1,"value":"KS Sales"}
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order property |
orderId |
Int |
The ID of the order that the property belongs to |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
|
value |
String |
The value of the property. The value depends on the type. |
{"orderId":66,"typeId":1,"value":"KS Sales","createdAt":"2016-02-23T08:23:02+01:00","updatedAt":"2016-02-23T08:23:02+01:00"}
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 a property of an order by order ID and property ID
Updates the value of a property. The composite key of the property must be specified. The composite key is composed of the ID of the order and the ID of the order property type.
/rest/orders/{orderId}/properties/{typeId}
Request
Field |
Type |
Description |
orderId |
Int |
The ID of the order that the property belongs to required |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
required |
value |
String |
The value of the property. The value depends on the type. required |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order property |
orderId |
Int |
The ID of the order that the property belongs to |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
|
value |
String |
The value of the property. The value depends on the type. |
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 a property of an order by property ID
Updates the value of a property. The ID of the property must be specified.
/rest/orders/properties/{id}
Request
Field |
Type |
Description |
id |
Int |
The ID of the order property required |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
required |
value |
String |
The value of the property. The value depends on the type. required |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the order property |
orderId |
Int |
The ID of the order that the property belongs to |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
|
value |
String |
The value of the property. The value depends on the type. |
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 a property of an order by property ID
Deletes a property of an order. The ID of the property must be specified.
/rest/orders/properties/{id}
Parameters
Field |
Type |
Description |
id |
Int |
The ID of the property to be deleted. |
Success 200
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 a property of an order by order ID and type ID
Deletes a property of an order. The composite key of the property must be specified. The composite key is composed of the ID of the order and the ID of the order property type.
/rest/orders/{orderId}/properties/{typeId}
Request
Field |
Type |
Description |
orderId |
Int |
The ID of the order that the property belongs to required |
typeId |
Int |
The ID of the property type. The following types are available:
- WAREHOUSE = 1
- SHIPPING_PROFILE = 2
- PAYMENT_METHOD = 3
- PAYMENT_STATUS = 4
- EXTERNAL_SHIPPING_PROFILE = 5
- DOCUMENT_LANGUAGE = 6
- EXTERNAL_ORDER_ID = 7
- CUSTOMER_SIGN = 8
- DUNNING_LEVEL = 9
- SELLER_ACCOUNT = 10
- WEIGHT = 11
- WIDTH = 12
- LENGTH = 13
- HEIGHT = 14
- FLAG = 15
- EXTERNAL_TOKEN_ID = 16
- EXTERNAL_ITEM_ID = 17
- COUPON_CODE = 18
- COUPON_TYPE = 19
- SALES_TAX_ID_NUMBER = 34
- MAIN_DOCUMENT_NUMBER = 33
- PAYMENT_TRANSACTION_ID = 45
- EXTERNAL_TAX_SERVICE = 47
- MERCHANT_ID = 60
- REPORT_ID = 61
- EBAY_PLUS = 994
- FULFILLMENT_SERVICE = 995
required |
Success 200
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. |
List order property types
Lists property types and their names in all languages. Optionally one or more languages can be specified to get a limited response.
/rest/orders/properties/types
Parameters
Field |
Type |
Description |
lang |
String[] |
Languages to be loaded with the type model. Defaults to all. |
Success 200
Response is a List
Field |
Type |
Description |
id |
Int |
The ID of the property type |
isErasable |
Bool |
Flag that states if this type can be deleted or not. |
position |
Int |
The position for sorting |
cast |
String |
The data type of the values of this property type. Valid types are:
- string
- int
- numeric
- bool
- enum(val1,val2,val3,...)
|
names |
\OrderPropertyTypeName[] |
The names of the order property types. (List) |
id |
Int |
The ID of type name |
typeId |
Int |
The ID of the property type |
name |
String |
The name of property type |
lang |
String |
The language of the type name |
[{"id":26,"isErasable":false,"position":20112401,"cast":"enum(val1,val2,val3)","names":[{"typeId":26,"lang":"ki","name":"blanditiis"},{"typeId":26,"lang":"ha","name":"aliquam"}]},{"id":39,"isErasable":false,"position":65,"cast":null,"names":[{"typeId":39,"lang":"ny","name":"provident"},{"typeId":39,"lang":"ve","name":"reprehenderit"}]}]
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 a property type
Gets a property type and its names in all languages. Optionally one or more languages can be specified to get a limited response.
/rest/orders/properties/types/{typeId}
Parameters
Field |
Type |
Description |
typeId |
Int |
The ID of the type. |
lang |
String[] |
Languages to be loaded with the type model. Defaults to all. |
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the property type |
isErasable |
Bool |
Flag that states if this type can be deleted or not. |
position |
Int |
The position for sorting |
cast |
String |
The data type of the values of this property type. Valid types are:
- string
- int
- numeric
- bool
- enum(val1,val2,val3,...)
|
names |
\OrderPropertyTypeName[] |
The names of the order property types. (List) |
id |
Int |
The ID of type name |
typeId |
Int |
The ID of the property type |
name |
String |
The name of property type |
lang |
String |
The language of the type name |
{"id":17,"isErasable":true,"position":94,"cast":"boolean","names":[{"typeId":17,"lang":"fa","name":"sit"},{"typeId":17,"lang":"xh","name":"repellendus"},{"typeId":17,"lang":"nn","name":"aut"}]}
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 property type
/rest/orders/properties/types
Request
Field |
Type |
Description |
position |
Int |
The position for sorting |
cast |
String |
The data type of the values of this property type. Valid types are:
- string
- int
- numeric
- bool
- enum(val1,val2,val3,...)
optional |
names |
\OrderPropertyTypeName[] |
The names of the order property types. required array |
lang |
String |
The language of the type name required |
name |
String |
The name of property type required |
{"position":20,"cast":"int","names":[{"lang":"de","name":"Ein neuer Typ"},{"lang":"en","name":"A new type"}]}
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the property type |
isErasable |
Bool |
Flag that states if this type can be deleted or not. |
position |
Int |
The position for sorting |
cast |
String |
The data type of the values of this property type. Valid types are:
- string
- int
- numeric
- bool
- enum(val1,val2,val3,...)
|
names |
\OrderPropertyTypeName[] |
The names of the order property types. (List) |
id |
Int |
The ID of type name |
typeId |
Int |
The ID of the property type |
name |
String |
The name of property type |
lang |
String |
The language of the type name |
{"id":1001,"isErasable":true,"position":20,"cast":"int","names":[{"lang":"de","name":"Ein neuer Typ"},{"lang":"en","name":"A new type"}]}
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 a property type.
Updates a property type and its names. The ID of the type must be specified. You can also create new names, if you provide data which does not yet exist.
/rest/orders/properties/types/{typeId}
Request
Field |
Type |
Description |
position |
Int |
The position for sorting |
names |
\OrderPropertyTypeName[] |
The names of the order property types. optional array |
lang |
String |
The language of the type name required |
name |
String |
The name of property type required |
{"names":[{"lang":"en","name":"a new FANCY type"},{"lang":"fr","name":"un chic type"}]}
Success 200
Field |
Type |
Description |
id |
Int |
The ID of the property type |
isErasable |
Bool |
Flag that states if this type can be deleted or not. |
position |
Int |
The position for sorting |
cast |
String |
The data type of the values of this property type. Valid types are:
- string
- int
- numeric
- bool
- enum(val1,val2,val3,...)
|
names |
\OrderPropertyTypeName[] |
The names of the order property types. (List) |
id |
Int |
The ID of type name |
typeId |
Int |
The ID of the property type |
name |
String |
The name of property type |
lang |
String |
The language of the type name |
{"id":1001,"isErasable":true,"position":20,"cast":"int","names":[{"lang":"de","name":"Ein neuer Typ"},{"lang":"en","name":"A new FANCY type"},{"lang":"fr","name":"un chic type"}]}
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 a property type.
Deletes a property type and all names for it from the database. The ID of the type must be specified.
/rest/orders/properties/types/{typeId}
Parameters
Field |
Type |
Description |
typeId |
Int |
The ID of the property type |
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. |