REST Order OrderDate

The dates for an order. Each date has a type and each type can have several names, but only one name per language.

List names of an order date type

Lists names in all languages available of an order date type. The ID of the date type must be specified.

/rest/orders/dates/types/{typeId}/names

Parameters

Field	Type	Description
typeId	`Int`	The Id of the OrderDateType to be found

Success 200

Response is a List

Field	Type	Description
`id`	`Int`	The ID of the order date type name
`typeId`	`Int`	The ID of the date type that this name belongs to. The following date types are available: Deleted on = 1 Created on = 2 Paid date = 3 Last update = 4 Completed on = 5 Return date = 6 Payment due date = 7 Estimated shipping date = 8 Start date = 9 End date = 10 Possible delivery date = 11 Market transfer date = 12
`lang`	`String`	The ISO 639-1 language code for the name, e.g. "en" for English
`name`	`String`	The name of the order date 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.

Get a name of an order date type

Gets a name of an order date type. The ID of the date type and the language of the name must be specified.

/rest/orders/dates/types/{typeId}/names/{lang}

Parameters

Field	Type	Description
typeId	`Int`	The ID of the order date type to be found
lang	`String`	The language of the order date type name

Success 200

Field	Type	Description
`id`	`Int`	The ID of the order date type name
`typeId`	`Int`	The ID of the date type that this name belongs to. The following date types are available: Deleted on = 1 Created on = 2 Paid date = 3 Last update = 4 Completed on = 5 Return date = 6 Payment due date = 7 Estimated shipping date = 8 Start date = 9 End date = 10 Possible delivery date = 11 Market transfer date = 12
`lang`	`String`	The ISO 639-1 language code for the name, e.g. "en" for English
`name`	`String`	The name of the order date 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.

List order date types

/rest/orders/dates/types

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.

Find an order date type by it's ID

/rest/orders/dates/types/{typeId}

Success 200

Field	Type	Description
`id`	`Int`	The ID of the order date type. The following date types are available: Deleted on = 1 Created on = 2 Paid date = 3 Last update = 4 Completed on = 5 Return date = 6 Payment due date = 7 Estimated shipping date = 8 Start date = 9 End date = 10 Possible delivery date = 11 Market transfer date = 12 Subscription cancelled on = 13 Subscription last run = 14 Subscription next run = 15
`isErasable`	`Bool`	Flag that indicates if this type can be deleted or not.
`position`	`Int`	The position for sorting

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 dates of an order

Lists dates of an order. The ID of the order must be specified.

/rest/orders/{orderId}/dates

Parameters

Field	Type	Description
orderId	`Int`	The ID of the order

Success 200

Response is a List

Field	Type	Description
`id`	`Int`	The ID of the order date
`orderId`	`Int`	The ID of the order that the date belongs to
`typeId`	`Int`	The ID of the date type. The following types are available: Deleted on = 1 Created on = 2 Paid date = 3 Last update = 4 Completed date = 5 Return date = 6 Payment due date = 7 Estimated shipping date = 8 Start date = 9 End date = 10 Estimated delivery date = 11 Market transfer date = 12 Subscription cancelled on = 13 Subscription last run = 14 Subscription next run = 15 Purchase date = 16 Finish date = 17
`createdAt`	`String\|\Carbon`	The date when the date was created
`updatedAt`	`String\|\Carbon`	The date when the date 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 a date

Gets a date. The ID of the order and the ID of the date type must be specified.

/rest/orders/{orderId}/dates/{typeId}

Parameters

Field	Type	Description
typeId	`Int`	The ID of the order date type to be found
orderId	`Int`	The ID of the order

Success 200

Field	Type	Description
`id`	`Int`	The ID of the order date
`orderId`	`Int`	The ID of the order that the date belongs to
`typeId`	`Int`	The ID of the date type. The following types are available: Deleted on = 1 Created on = 2 Paid date = 3 Last update = 4 Completed date = 5 Return date = 6 Payment due date = 7 Estimated shipping date = 8 Start date = 9 End date = 10 Estimated delivery date = 11 Market transfer date = 12 Subscription cancelled on = 13 Subscription last run = 14 Subscription next run = 15 Purchase date = 16 Finish date = 17
`createdAt`	`String\|\Carbon`	The date when the date was created
`updatedAt`	`String\|\Carbon`	The date when the date 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.