Area
GET /api/locations/area
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.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.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/locations/area
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/locations/area
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/locations/area[/:area_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.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.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/locations/area[/:area_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/locations/area[/:area_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
PATCH /api/locations/area[/:area_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Countries
Locations service
GET /api/locations/countries
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.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.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/locations/countries
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/locations/countries
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/locations/countries[/:countries_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.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.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/locations/countries[/:countries_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.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
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/locations/countries[/:countries_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/locations/countries[/:countries_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Localities
Locations service
GET /api/locations/localities
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/locations/localities
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.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.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/locations/localities
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.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
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/locations/localities[/:localities_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/locations/localities[/:localities_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.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
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/locations/localities[/:localities_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\locations\api.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
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/locations/localities[/:localities_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\locations\api.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
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\locations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |