Category
GET /api/products/category
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/category[/:category_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/category[/:category_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
OrderDocument
Documents
GET /api/products/order-document
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | YES | ||
| template | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/order-document
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | YES | ||
| template | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order-document
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | YES | ||
| template | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/order-document[/:order_document_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | YES | ||
| template | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order-document[/:order_document_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | YES | ||
| template | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/products/order-document[/:order_document_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | YES | ||
| template | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /api/products/order-document[/:order_document_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | YES | ||
| template | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
OrderProduct
GET /api/products/order/product
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/order/product
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/products/order/product
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order/product
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/order/product[/:order_product_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order/product[/:order_product_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/products/order/product[/:order_product_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
PUT /api/products/order/product[/:order_product_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| raw | NO | ||
| extId | NO | ||
| order | YES | ||
| total | NO | ||
| currency | NO | ||
| tax | NO | ||
| count | NO | ||
| productOffer | NO | ||
| price | NO | ||
| shop | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Bulk
POST /api/products/order/product/bulk[/:order_product_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json
application/*+json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
| Header | Value |
|---|---|
| Content-Type | application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/order/product/bulk[/:order_product_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
OrderReserve
GET /api/products/order-reserve
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | NO | ||
| items | NO | ||
| timeLimit | YES | ||
| warehouse | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/order-reserve
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | NO | ||
| items | NO | ||
| timeLimit | YES | ||
| warehouse | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/order-reserve[/:order_reserve_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | NO | ||
| items | NO | ||
| timeLimit | YES | ||
| warehouse | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order-reserve[/:order_reserve_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | NO | ||
| items | NO | ||
| timeLimit | YES | ||
| warehouse | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/products/order-reserve[/:order_reserve_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | YES | ||
| order | NO | ||
| items | NO | ||
| timeLimit | YES | ||
| warehouse | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
OrderReturn
GET /api/products/order-return
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| document | YES | ||
| order | YES | ||
| items | NO | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/order-return
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| document | YES | ||
| order | YES | ||
| items | NO | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/order-return[/:order_return_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| document | YES | ||
| order | YES | ||
| items | NO | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order-return[/:order_return_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| document | YES | ||
| order | YES | ||
| items | NO | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/products/order-return[/:order_return_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| document | YES | ||
| order | YES | ||
| items | NO | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
OrderStatus
Statuses
GET /api/products/order-status[/:order_status_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Order
GET /api/products/order
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| shop | YES | ||
| status | NO | ||
| date | NO | ||
| profile | NO | ||
| address | NO | ||
| state | NO | ||
| paymentState | NO | ||
| extId | NO | ||
| phone | NO | ||
| orderPrice | NO | ||
| totalPrice | NO | ||
| comment | NO | ||
| eav | NO | ||
| stateDescription | NO | ||
| type | NO | ||
| recipientName | NO | ||
| NO | |||
| recipientName | NO | ||
| phone | NO | ||
| discountPrice | NO | ||
| orderProducts | NO | ||
| services | NO | ||
| orderReserve | NO | ||
| extCreated | NO | ||
| source | NO | ||
| shipmentDate | NO | ||
| clientId | NO | ||
| shippedByDocument | NO | ||
| raw | NO | ||
| owner | NO | ||
| deliveryRequest | NO | ||
| currency | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/order
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| shop | YES | ||
| status | NO | ||
| date | NO | ||
| profile | NO | ||
| address | NO | ||
| state | NO | ||
| paymentState | NO | ||
| extId | NO | ||
| phone | NO | ||
| orderPrice | NO | ||
| totalPrice | NO | ||
| comment | NO | ||
| eav | NO | ||
| stateDescription | NO | ||
| type | NO | ||
| recipientName | NO | ||
| NO | |||
| recipientName | NO | ||
| phone | NO | ||
| discountPrice | NO | ||
| orderProducts | NO | ||
| services | NO | ||
| orderReserve | NO | ||
| extCreated | NO | ||
| source | NO | ||
| shipmentDate | NO | ||
| clientId | NO | ||
| shippedByDocument | NO | ||
| raw | NO | ||
| owner | NO | ||
| deliveryRequest | NO | ||
| currency | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| shop | YES | ||
| status | NO | ||
| date | NO | ||
| profile | NO | ||
| address | NO | ||
| state | NO | ||
| paymentState | NO | ||
| extId | NO | ||
| phone | NO | ||
| orderPrice | NO | ||
| totalPrice | NO | ||
| comment | NO | ||
| eav | NO | ||
| stateDescription | NO | ||
| type | NO | ||
| recipientName | NO | ||
| NO | |||
| recipientName | NO | ||
| phone | NO | ||
| discountPrice | NO | ||
| orderProducts | NO | ||
| services | NO | ||
| orderReserve | NO | ||
| extCreated | NO | ||
| source | NO | ||
| shipmentDate | NO | ||
| clientId | NO | ||
| shippedByDocument | NO | ||
| raw | NO | ||
| owner | NO | ||
| deliveryRequest | NO | ||
| currency | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/order[/:order_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| shop | YES | ||
| status | NO | ||
| date | NO | ||
| profile | NO | ||
| address | NO | ||
| state | NO | ||
| paymentState | NO | ||
| extId | NO | ||
| phone | NO | ||
| orderPrice | NO | ||
| totalPrice | NO | ||
| comment | NO | ||
| eav | NO | ||
| stateDescription | NO | ||
| type | NO | ||
| recipientName | NO | ||
| NO | |||
| recipientName | NO | ||
| phone | NO | ||
| discountPrice | NO | ||
| orderProducts | NO | ||
| services | NO | ||
| orderReserve | NO | ||
| extCreated | NO | ||
| source | NO | ||
| shipmentDate | NO | ||
| clientId | NO | ||
| shippedByDocument | NO | ||
| raw | NO | ||
| owner | NO | ||
| deliveryRequest | NO | ||
| currency | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/order[/:order_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| shop | YES | ||
| status | NO | ||
| date | NO | ||
| profile | NO | ||
| address | NO | ||
| state | NO | ||
| paymentState | NO | ||
| extId | NO | ||
| phone | NO | ||
| orderPrice | NO | ||
| totalPrice | NO | ||
| comment | NO | ||
| eav | NO | ||
| stateDescription | NO | ||
| type | NO | ||
| recipientName | NO | ||
| NO | |||
| recipientName | NO | ||
| phone | NO | ||
| discountPrice | NO | ||
| orderProducts | NO | ||
| services | NO | ||
| orderReserve | NO | ||
| extCreated | NO | ||
| source | NO | ||
| shipmentDate | NO | ||
| clientId | NO | ||
| shippedByDocument | NO | ||
| raw | NO | ||
| owner | NO | ||
| deliveryRequest | NO | ||
| currency | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/order[/:order_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| shop | YES | ||
| status | NO | ||
| date | NO | ||
| profile | NO | ||
| address | NO | ||
| state | NO | ||
| paymentState | NO | ||
| extId | NO | ||
| phone | NO | ||
| orderPrice | NO | ||
| totalPrice | NO | ||
| comment | NO | ||
| eav | NO | ||
| stateDescription | NO | ||
| type | NO | ||
| recipientName | NO | ||
| NO | |||
| recipientName | NO | ||
| phone | NO | ||
| discountPrice | NO | ||
| orderProducts | NO | ||
| services | NO | ||
| orderReserve | NO | ||
| extCreated | NO | ||
| source | NO | ||
| shipmentDate | NO | ||
| clientId | NO | ||
| shippedByDocument | NO | ||
| raw | NO | ||
| owner | NO | ||
| deliveryRequest | NO | ||
| currency | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
ProductOffer
GET /api/products/offer[/:shop_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| article | NO | ||
| shop | YES | ||
| name | YES | ||
| type | YES | ||
| parentShop | NO | ||
| parent | NO | ||
| upcs | NO | ||
| eans | NO | ||
| barcodes | NO | ||
| dimensions | NO | ||
| supplier | NO | ||
| weight | NO | ||
| purchasingPrice | NO | ||
| price | NO | ||
| state | NO | ||
| extId | NO | ||
| raw | NO | ||
| eav | NO | ||
| image | NO | ||
| group-type | NO | ||
| currency | NO | ||
| productOffer | NO | ||
| serviceRules | NO | ||
| docExtended | NO | ||
| sku | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/offer[/:shop_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| article | NO | ||
| shop | YES | ||
| name | YES | ||
| type | YES | ||
| parentShop | NO | ||
| parent | NO | ||
| upcs | NO | ||
| eans | NO | ||
| barcodes | NO | ||
| dimensions | NO | ||
| supplier | NO | ||
| weight | NO | ||
| purchasingPrice | NO | ||
| price | NO | ||
| state | NO | ||
| extId | NO | ||
| raw | NO | ||
| eav | NO | ||
| image | NO | ||
| group-type | NO | ||
| currency | NO | ||
| productOffer | NO | ||
| serviceRules | NO | ||
| docExtended | NO | ||
| sku | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/offer[/:shop_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| article | NO | ||
| shop | YES | ||
| name | YES | ||
| type | YES | ||
| parentShop | NO | ||
| parent | NO | ||
| upcs | NO | ||
| eans | NO | ||
| barcodes | NO | ||
| dimensions | NO | ||
| supplier | NO | ||
| weight | NO | ||
| purchasingPrice | NO | ||
| price | NO | ||
| state | NO | ||
| extId | NO | ||
| raw | NO | ||
| eav | NO | ||
| image | NO | ||
| group-type | NO | ||
| currency | NO | ||
| productOffer | NO | ||
| serviceRules | NO | ||
| docExtended | NO | ||
| sku | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/offer[/:shop_id][/:product_offer_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| article | NO | ||
| shop | YES | ||
| name | YES | ||
| type | YES | ||
| parentShop | NO | ||
| parent | NO | ||
| upcs | NO | ||
| eans | NO | ||
| barcodes | NO | ||
| dimensions | NO | ||
| supplier | NO | ||
| weight | NO | ||
| purchasingPrice | NO | ||
| price | NO | ||
| state | NO | ||
| extId | NO | ||
| raw | NO | ||
| eav | NO | ||
| image | NO | ||
| group-type | NO | ||
| currency | NO | ||
| productOffer | NO | ||
| serviceRules | NO | ||
| docExtended | NO | ||
| sku | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/offer[/:shop_id][/:product_offer_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| article | NO | ||
| shop | YES | ||
| name | YES | ||
| type | YES | ||
| parentShop | NO | ||
| parent | NO | ||
| upcs | NO | ||
| eans | NO | ||
| barcodes | NO | ||
| dimensions | NO | ||
| supplier | NO | ||
| weight | NO | ||
| purchasingPrice | NO | ||
| price | NO | ||
| state | NO | ||
| extId | NO | ||
| raw | NO | ||
| eav | NO | ||
| image | NO | ||
| group-type | NO | ||
| currency | NO | ||
| productOffer | NO | ||
| serviceRules | NO | ||
| docExtended | NO | ||
| sku | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/products/offer[/:shop_id][/:product_offer_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| noTask | NO | ||
| article | NO | ||
| shop | YES | ||
| name | YES | ||
| type | YES | ||
| parentShop | NO | ||
| parent | NO | ||
| upcs | NO | ||
| eans | NO | ||
| barcodes | NO | ||
| dimensions | NO | ||
| supplier | NO | ||
| weight | NO | ||
| purchasingPrice | NO | ||
| price | NO | ||
| state | NO | ||
| extId | NO | ||
| raw | NO | ||
| eav | NO | ||
| image | NO | ||
| group-type | NO | ||
| currency | NO | ||
| productOffer | NO | ||
| serviceRules | NO | ||
| docExtended | NO | ||
| sku | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json
application/pdf
multipart/form-data
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
ServiceRule
GET /api/products/service/rule
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO | ||
| warehouse | NO | ||
| shop | NO | ||
| conditions | NO | ||
| settings | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/service/rule
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO | ||
| warehouse | NO | ||
| shop | NO | ||
| conditions | NO | ||
| settings | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/service/rule
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO | ||
| warehouse | NO | ||
| shop | NO | ||
| conditions | NO | ||
| settings | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/service/rule[/:service_rule_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO | ||
| warehouse | NO | ||
| shop | NO | ||
| conditions | NO | ||
| settings | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/service/rule[/:service_rule_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO | ||
| warehouse | NO | ||
| shop | NO | ||
| conditions | NO | ||
| settings | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/products/service/rule[/:service_rule_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO | ||
| warehouse | NO | ||
| shop | NO | ||
| conditions | NO | ||
| settings | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /api/products/service/rule[/:service_rule_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO | ||
| warehouse | NO | ||
| shop | NO | ||
| conditions | NO | ||
| settings | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Service
Service
GET /api/products/service
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| order | YES | ||
| count | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/service
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| order | YES | ||
| count | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/service
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| order | YES | ||
| count | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| order | YES | ||
| count | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| order | YES | ||
| count | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/products/service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| order | YES | ||
| count | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /api/products/service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| order | YES | ||
| count | NO | ||
| price | NO | ||
| tax | NO | ||
| name | YES | ||
| code | NO | ||
| supply | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Shop
GET /api/products/shops
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| owner | NO | ||
| name | YES | ||
| eav | array | NO | |
| parent | NO | ||
| serviceRules | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/shops
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| owner | NO | ||
| name | YES | ||
| eav | array | NO | |
| parent | NO | ||
| serviceRules | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\api.v1+json
application/hal+json
application/json |
| Content-Type | |
| 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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/shops
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| owner | NO | ||
| name | YES | ||
| eav | array | NO | |
| parent | NO | ||
| serviceRules | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\api.v1+json
application/hal+json
application/json |
| Content-Type | |
| 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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/shops[/:shop_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| owner | NO | ||
| name | YES | ||
| eav | array | NO | |
| parent | NO | ||
| serviceRules | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/shops[/:shop_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| owner | NO | ||
| name | YES | ||
| eav | array | NO | |
| parent | NO | ||
| serviceRules | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\shops\api.v1+json
application/hal+json
application/json |
| Content-Type | |
| 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\shops\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Supplier
GET /api/products/suppliers
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/suppliers
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/suppliers
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/products/suppliers[/:supplier_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\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\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/products/suppliers[/:supplier_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/products/suppliers[/:supplier_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\products\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |