REST Order OrderItemDate

Provides find, create, update and delete for order item dates.

List dates of an order item

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

/rest/orders/items/{orderItemId}/dates

Parameters

Field Type Description
orderItemId Int The order item ID of the order item date instance to be loaded

Success 200

Field Type Description
id Int The ID of the order date
orderItemId Int The ID of the order item that the date belongs to
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
createdAt String|\Carbon The date when the date was created
updatedAt String|\Carbon The date when the date was last updated
[{"id":2135,"orderItemId":59553,"typeId":9,"date":"2016-12-03T21:54:19+01:00","createdAt":"2007-07-31T23:02:05+02:00","updatedAt":"2007-07-31T23:02:05+02:00"},{"id":2727,"orderItemId":28654,"typeId":10,"date":"1991-04-03T01:54:02+02:00","createdAt":"2000-09-24T07:13:50+02:00","updatedAt":"2000-09-24T07:13:50+02: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.

Get a date of an order item by order item and date type

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

/rest/orders/items/{orderItemId}/dates/{typeId}

Parameters

Field Type Description
orderItemId Int The ID of the order item
typeId Int The ID of the order date type

Success 200

Field Type Description
id Int The ID of the order date
orderItemId Int The ID of the order item that the date belongs to
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
createdAt String|\Carbon The date when the date was created
updatedAt String|\Carbon The date when the date was last updated
{"id":2562,"orderItemId":17105,"typeId":10,"date":"2006-03-31T13:17:42+02:00","createdAt":"2005-03-16T00:22:04+01:00","updatedAt":"2005-03-16T00:22:04+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 date for an order item by order item and date type

Creates a date for an order item. The ID of the order item and the ID of the date type must be specified.

/rest/orders/items/{orderItemId}/dates/{typeId}

Parameters

Field Type Description
orderItemId Int The ID of the order item
typeId Int The ID of the order date type

Request

Field Type Description
orderItemId Int The ID of the order item that the date belongs to optional required with typeId
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
optional required with orderItemId
date \Carbon The date plus hours, minutes and seconds. The date format must comply with the W3C standard. required
null

Success 200

Field Type Description
id Int The ID of the order date
orderItemId Int The ID of the order item that the date belongs to
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
createdAt String|\Carbon The date when the date was created
updatedAt String|\Carbon The date when the date was last updated
{"id":2541,"orderItemId":63252,"typeId":9,"date":"1973-04-23T04:34:20+01:00","createdAt":"2013-10-24T20:29:51+02:00","updatedAt":"2013-10-24T20:29:51+02: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 date of an order item by order item and date type

Updates the date of an order item. The ID of the order item and the ID of the date type must be specified.

/rest/orders/items/{orderItemId}/dates/{typeId}

Parameters

Field Type Description
orderItemId Int The ID of the order item
typeId Int The ID of the order date type

Request

Field Type Description
orderItemId Int The ID of the order item that the date belongs to optional
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
optional
date \Carbon The date plus hours, minutes and seconds. The date format must comply with the W3C standard. required
null

Success 200

Field Type Description
id Int The ID of the order date
orderItemId Int The ID of the order item that the date belongs to
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
createdAt String|\Carbon The date when the date was created
updatedAt String|\Carbon The date when the date was last updated
{"id":4361,"orderItemId":15002,"typeId":10,"date":"2005-08-27T03:55:55+02:00","createdAt":"1993-12-27T20:00:45+01:00","updatedAt":"1993-12-27T20:00:45+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.

Delete a date from an order item by order item and date type

Deletest a date from an order item. The ID of the order item and the ID of the date type must be specified.

/rest/orders/items/{orderItemId}/dates/{typeId}

Parameters

Field Type Description
orderItemId Int The ID of the order item
typeId Int The ID of the order date

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 a date of an order item

Gets a date of an order item. The ID of the date must be specified.

/rest/orders/items/dates/{id}

Parameters

Field Type Description
id Int The ID of the order item date

Success 200

Field Type Description
id Int The ID of the order date
orderItemId Int The ID of the order item that the date belongs to
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
createdAt String|\Carbon The date when the date was created
updatedAt String|\Carbon The date when the date was last updated
{"id":3007,"orderItemId":50089,"typeId":10,"date":"2006-09-04T11:59:33+02:00","createdAt":"1973-08-23T02:24:41+01:00","updatedAt":"1973-08-23T02:24:41+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 date for an order item

Creates a date for an order item. The ID of the order item must be specified

/rest/orders/items/dates

Request

Field Type Description
orderItemId Int The ID of the order item that the date belongs to optional required with typeId
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
optional required with orderItemId
date \Carbon The date plus hours, minutes and seconds. The date format must comply with the W3C standard. required
null

Success 200

Field Type Description
id Int The ID of the order date
orderItemId Int The ID of the order item that the date belongs to
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
createdAt String|\Carbon The date when the date was created
updatedAt String|\Carbon The date when the date was last updated
{"id":5515,"orderItemId":46727,"typeId":9,"date":"2009-01-22T15:39:16+01:00","createdAt":"2012-01-30T10:52:02+01:00","updatedAt":"2012-01-30T10:52: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 date of an order item

Updates a date of an order item. The ID of the date must be specified.

/rest/orders/items/dates/{id}

Parameters

Field Type Description
id Int The ID of the order item date

Request

Field Type Description
orderItemId Int The ID of the order item that the date belongs to optional
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
optional
date \Carbon The date plus hours, minutes and seconds. The date format must comply with the W3C standard. required
null

Success 200

Field Type Description
id Int The ID of the order date
orderItemId Int The ID of the order item that the date belongs to
typeId Int The ID of the date type. The following types are available:
  • Start date = 9
  • End date = 10
  • Estimated delivery date = 11
createdAt String|\Carbon The date when the date was created
updatedAt String|\Carbon The date when the date was last updated
{"id":3152,"orderItemId":13261,"typeId":9,"date":"1993-11-02T16:37:24+01:00","createdAt":"1971-12-30T11:26:42+01:00","updatedAt":"1971-12-30T11:26:42+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.

Delete a date from an order item

Deletes the date from an order item. The ID of the date must be specified.

/rest/orders/items/dates/{id}

Parameters

Field Type Description
id Int The ID of the order item date

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.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!