Order
Create, manipulate and retrieve orders.
GET /plans/[:plan_id]/[:node_location_id]/orders
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The order entity (unique) ID. | NO |
| order_id | The order internal ID. | NO |
| order_date | The order creation date in this format: YYYY-mm-dd | NO |
| order_time | The order creation time in this format: hh:mm:ss | NO |
| store_id | The order store ID. | NO |
| shipping_type | The order shipping type. | NO |
| address | The member address. | NO |
| city | The member city. | NO |
| state | The member state. | NO |
| zipcode | The member 5-digits zip code. | NO |
| telephone_number | The member telephone number. | NO |
| picked_at | The date the order was picked at. | NO |
| period_factor | The order period factor. | NO |
| top_amount | The order top amount. | NO |
| order_type | The order type. | NO |
| status | The order status. | NO |
| created_at | The order creation date. | NO |
| orderitems | The items associated to the order. | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orders.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orders.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /plans/[:plan_id]/[:node_location_id]/orders
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The order entity (unique) ID. | NO |
| order_id | The order internal ID. | NO |
| order_date | The order creation date in this format: YYYY-mm-dd | NO |
| order_time | The order creation time in this format: hh:mm:ss | NO |
| store_id | The order store ID. | NO |
| shipping_type | The order shipping type. | NO |
| address | The member address. | NO |
| city | The member city. | NO |
| state | The member state. | NO |
| zipcode | The member 5-digits zip code. | NO |
| telephone_number | The member telephone number. | NO |
| picked_at | The date the order was picked at. | NO |
| period_factor | The order period factor. | NO |
| top_amount | The order top amount. | NO |
| order_type | The order type. | NO |
| status | The order status. | NO |
| created_at | The order creation date. | NO |
| orderitems | The items associated to the order. | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orders.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orders.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orders.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /plans/[:plan_id]/[:node_location_id]/orders[/:order_id]
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The order entity (unique) ID. | NO |
| order_id | The order internal ID. | NO |
| order_date | The order creation date in this format: YYYY-mm-dd | NO |
| order_time | The order creation time in this format: hh:mm:ss | NO |
| store_id | The order store ID. | NO |
| shipping_type | The order shipping type. | NO |
| address | The member address. | NO |
| city | The member city. | NO |
| state | The member state. | NO |
| zipcode | The member 5-digits zip code. | NO |
| telephone_number | The member telephone number. | NO |
| picked_at | The date the order was picked at. | NO |
| period_factor | The order period factor. | NO |
| top_amount | The order top amount. | NO |
| order_type | The order type. | NO |
| status | The order status. | NO |
| created_at | The order creation date. | NO |
| orderitems | The items associated to the order. | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orders.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orders.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |