Calculator
Delivery cost calculator.
POST /api/delivery-services/calculator
A query for calculation of the rates.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| debug | optional filed, true or false if we are going to specify |
NO | |
| clearCache | optional filed, true or false if we are going to specify |
NO | |
| from | the from locality will be taken from sender settings |
NO | |
| to | for TO we should specify locality ID / in example is St. Petersburg |
NO | |
| estimatedCost | estimated cost of the order |
NO | |
| payment | amount to be paid by the client |
NO | |
| weight | the weight should be specified in grams |
NO | |
| width | the width must be specified in mm |
NO | |
| height | the height must be stated in mm |
NO | |
| length | the length must be stated in mm |
NO | |
| sender | the sender ID should be specified |
NO | |
| deliveryServices | the delivery service ID should be specified |
NO | |
| timeout | result waiting time in seconds |
NO | |
| divisor | NO | ||
| servicePoints | Are we going to show service points in calculation result |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/calculator[/:calculator_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| debug | optional filed, true or false if we are going to specify |
NO | |
| clearCache | optional filed, true or false if we are going to specify |
NO | |
| from | the from locality will be taken from sender settings |
NO | |
| to | for TO we should specify locality ID / in example is St. Petersburg |
NO | |
| estimatedCost | estimated cost of the order |
NO | |
| payment | amount to be paid by the client |
NO | |
| weight | the weight should be specified in grams |
NO | |
| width | the width must be specified in mm |
NO | |
| height | the height must be stated in mm |
NO | |
| length | the length must be stated in mm |
NO | |
| sender | the sender ID should be specified |
NO | |
| deliveryServices | the delivery service ID should be specified |
NO | |
| timeout | result waiting time in seconds |
NO | |
| divisor | NO | ||
| servicePoints | Are we going to show service points in calculation result |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+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\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DeliveryRequestService
Delivery request services api
GET /api/delivery-services/delivery-request-service
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/delivery-request-service
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/delivery-request-service[/:delivery_request_service_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+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\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/delivery-request-service[/:delivery_request_service_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/delivery-request-service[/:delivery_request_service_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/delivery-request-service[/:delivery_request_service_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+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\delivery-services\api.v1+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
DeliveryRequest
GET /api/delivery-services/requests
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | state of the delivery request |
NO | |
| rate | rate of the delivery,need to specify the rate id |
YES | |
| currency | in example currency is in rubles, need to specify the currency id |
NO | |
| extId | extId should be unique |
NO | |
| clientExtId | an optional field |
NO | |
| deliveryService | object | Delivery service object |
NO |
| integration | object | Integration object |
NO |
| estimatedCost | estimated cost for the delivery request |
NO | |
| price | price of the order |
NO | |
| tax | Tax of the order |
NO | |
| retailPrice | Retail price of the delivery |
NO | |
| payment | the amount to be paid for shipment |
NO | |
| pickupDate | date on which the shipment will be handed to the delivery service |
NO | |
| sender | YES | ||
| sender | the sender ID should be specified |
NO | |
| senderAddress | the sender address will be taken from the sender settings |
NO | |
| senderName | the sender name will be taken from the sender settings |
NO | |
| senderPhone | the sender phone will be taken from the sender settings |
NO | |
| senderComment | the sender comment will be taken from the sender settings |
NO | |
| deliveryDate | date on which the shipment is expected to be delivered |
NO | |
| deliveryTimeStart | start time for delivery of the shipment |
NO | |
| deliveryTimeEnd | end time for delivery of the shipment |
NO | |
| recipient | name of the recipient |
NO | |
| recipientAddress | the recipient address should be transmitted in an array, entering - city, street, home, apartment, post code |
YES | |
| recipientRawAddress | raw type of recipient address |
NO | |
| recipientName | field for recipient name |
NO | |
| recipientPhone | Recipient phone number |
NO | |
| recipientComment | field for recipient comment |
NO | |
| recipientLocality | the recipient locality ID should be specified |
NO | |
| servicePoint | the service point ID should be specified |
NO | |
| weight | the weight should be specified in grams |
NO | |
| dimensions_x | the width must be specified in mm |
NO | |
| dimensions_y | the length must be stated in mm |
NO | |
| dimensions_z | the depth must be stated in mm |
NO | |
| trackingNumber | field to transmit the barcode |
NO | |
| documentNumber | number of the document / optional field |
NO | |
| documentDate | date of the document / optional field |
NO | |
| rawResult | field with raw result |
NO | |
| dimensions | filed for dimensions / optional field |
NO | |
| createdByDocument | field for specify the ID of acceptance document |
NO | |
| shippedByDocument | field for specify the ID of consumption document |
NO | |
| place | how many packages are needed for the order |
NO | |
| deliveryTasks | this field does not need to be filed |
NO | |
| outExtId | this is an optional field for out ext id |
NO | |
| places | field for transmitting the content of the delivery request |
NO | |
| comment | optional field for comment |
NO | |
| sendDate | date of sending the shipment |
NO | |
| senderProfile | the sender profile will be taken from the sender settings |
NO | |
| eav | eav attribute |
NO | |
| paymentState | NO | ||
| source | NO | ||
| deliveryServiceStatus | NO | ||
| rawData | NO | ||
| tracking | NO | ||
| volume | NO | ||
| order | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| 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\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/requests
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | state of the delivery request |
NO | |
| rate | rate of the delivery,need to specify the rate id |
YES | |
| currency | in example currency is in rubles, need to specify the currency id |
NO | |
| extId | extId should be unique |
NO | |
| clientExtId | an optional field |
NO | |
| deliveryService | object | Delivery service object |
NO |
| integration | object | Integration object |
NO |
| estimatedCost | estimated cost for the delivery request |
NO | |
| price | price of the order |
NO | |
| tax | Tax of the order |
NO | |
| retailPrice | Retail price of the delivery |
NO | |
| payment | the amount to be paid for shipment |
NO | |
| pickupDate | date on which the shipment will be handed to the delivery service |
NO | |
| sender | YES | ||
| sender | the sender ID should be specified |
NO | |
| senderAddress | the sender address will be taken from the sender settings |
NO | |
| senderName | the sender name will be taken from the sender settings |
NO | |
| senderPhone | the sender phone will be taken from the sender settings |
NO | |
| senderComment | the sender comment will be taken from the sender settings |
NO | |
| deliveryDate | date on which the shipment is expected to be delivered |
NO | |
| deliveryTimeStart | start time for delivery of the shipment |
NO | |
| deliveryTimeEnd | end time for delivery of the shipment |
NO | |
| recipient | name of the recipient |
NO | |
| recipientAddress | the recipient address should be transmitted in an array, entering - city, street, home, apartment, post code |
YES | |
| recipientRawAddress | raw type of recipient address |
NO | |
| recipientName | field for recipient name |
NO | |
| recipientPhone | Recipient phone number |
NO | |
| recipientComment | field for recipient comment |
NO | |
| recipientLocality | the recipient locality ID should be specified |
NO | |
| servicePoint | the service point ID should be specified |
NO | |
| weight | the weight should be specified in grams |
NO | |
| dimensions_x | the width must be specified in mm |
NO | |
| dimensions_y | the length must be stated in mm |
NO | |
| dimensions_z | the depth must be stated in mm |
NO | |
| trackingNumber | field to transmit the barcode |
NO | |
| documentNumber | number of the document / optional field |
NO | |
| documentDate | date of the document / optional field |
NO | |
| rawResult | field with raw result |
NO | |
| dimensions | filed for dimensions / optional field |
NO | |
| createdByDocument | field for specify the ID of acceptance document |
NO | |
| shippedByDocument | field for specify the ID of consumption document |
NO | |
| place | how many packages are needed for the order |
NO | |
| deliveryTasks | this field does not need to be filed |
NO | |
| outExtId | this is an optional field for out ext id |
NO | |
| places | field for transmitting the content of the delivery request |
NO | |
| comment | optional field for comment |
NO | |
| sendDate | date of sending the shipment |
NO | |
| senderProfile | the sender profile will be taken from the sender settings |
NO | |
| eav | eav attribute |
NO | |
| paymentState | NO | ||
| source | NO | ||
| deliveryServiceStatus | NO | ||
| rawData | NO | ||
| tracking | NO | ||
| volume | NO | ||
| order | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
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\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/requests
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | state of the delivery request |
NO | |
| rate | rate of the delivery,need to specify the rate id |
YES | |
| currency | in example currency is in rubles, need to specify the currency id |
NO | |
| extId | extId should be unique |
NO | |
| clientExtId | an optional field |
NO | |
| deliveryService | object | Delivery service object |
NO |
| integration | object | Integration object |
NO |
| estimatedCost | estimated cost for the delivery request |
NO | |
| price | price of the order |
NO | |
| tax | Tax of the order |
NO | |
| retailPrice | Retail price of the delivery |
NO | |
| payment | the amount to be paid for shipment |
NO | |
| pickupDate | date on which the shipment will be handed to the delivery service |
NO | |
| sender | YES | ||
| sender | the sender ID should be specified |
NO | |
| senderAddress | the sender address will be taken from the sender settings |
NO | |
| senderName | the sender name will be taken from the sender settings |
NO | |
| senderPhone | the sender phone will be taken from the sender settings |
NO | |
| senderComment | the sender comment will be taken from the sender settings |
NO | |
| deliveryDate | date on which the shipment is expected to be delivered |
NO | |
| deliveryTimeStart | start time for delivery of the shipment |
NO | |
| deliveryTimeEnd | end time for delivery of the shipment |
NO | |
| recipient | name of the recipient |
NO | |
| recipientAddress | the recipient address should be transmitted in an array, entering - city, street, home, apartment, post code |
YES | |
| recipientRawAddress | raw type of recipient address |
NO | |
| recipientName | field for recipient name |
NO | |
| recipientPhone | Recipient phone number |
NO | |
| recipientComment | field for recipient comment |
NO | |
| recipientLocality | the recipient locality ID should be specified |
NO | |
| servicePoint | the service point ID should be specified |
NO | |
| weight | the weight should be specified in grams |
NO | |
| dimensions_x | the width must be specified in mm |
NO | |
| dimensions_y | the length must be stated in mm |
NO | |
| dimensions_z | the depth must be stated in mm |
NO | |
| trackingNumber | field to transmit the barcode |
NO | |
| documentNumber | number of the document / optional field |
NO | |
| documentDate | date of the document / optional field |
NO | |
| rawResult | field with raw result |
NO | |
| dimensions | filed for dimensions / optional field |
NO | |
| createdByDocument | field for specify the ID of acceptance document |
NO | |
| shippedByDocument | field for specify the ID of consumption document |
NO | |
| place | how many packages are needed for the order |
NO | |
| deliveryTasks | this field does not need to be filed |
NO | |
| outExtId | this is an optional field for out ext id |
NO | |
| places | field for transmitting the content of the delivery request |
NO | |
| comment | optional field for comment |
NO | |
| sendDate | date of sending the shipment |
NO | |
| senderProfile | the sender profile will be taken from the sender settings |
NO | |
| eav | eav attribute |
NO | |
| paymentState | NO | ||
| source | NO | ||
| deliveryServiceStatus | NO | ||
| rawData | NO | ||
| tracking | NO | ||
| volume | NO | ||
| order | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
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\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/requests[/:delivery_request_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | state of the delivery request |
NO | |
| rate | rate of the delivery,need to specify the rate id |
YES | |
| currency | in example currency is in rubles, need to specify the currency id |
NO | |
| extId | extId should be unique |
NO | |
| clientExtId | an optional field |
NO | |
| deliveryService | object | Delivery service object |
NO |
| integration | object | Integration object |
NO |
| estimatedCost | estimated cost for the delivery request |
NO | |
| price | price of the order |
NO | |
| tax | Tax of the order |
NO | |
| retailPrice | Retail price of the delivery |
NO | |
| payment | the amount to be paid for shipment |
NO | |
| pickupDate | date on which the shipment will be handed to the delivery service |
NO | |
| sender | YES | ||
| sender | the sender ID should be specified |
NO | |
| senderAddress | the sender address will be taken from the sender settings |
NO | |
| senderName | the sender name will be taken from the sender settings |
NO | |
| senderPhone | the sender phone will be taken from the sender settings |
NO | |
| senderComment | the sender comment will be taken from the sender settings |
NO | |
| deliveryDate | date on which the shipment is expected to be delivered |
NO | |
| deliveryTimeStart | start time for delivery of the shipment |
NO | |
| deliveryTimeEnd | end time for delivery of the shipment |
NO | |
| recipient | name of the recipient |
NO | |
| recipientAddress | the recipient address should be transmitted in an array, entering - city, street, home, apartment, post code |
YES | |
| recipientRawAddress | raw type of recipient address |
NO | |
| recipientName | field for recipient name |
NO | |
| recipientPhone | Recipient phone number |
NO | |
| recipientComment | field for recipient comment |
NO | |
| recipientLocality | the recipient locality ID should be specified |
NO | |
| servicePoint | the service point ID should be specified |
NO | |
| weight | the weight should be specified in grams |
NO | |
| dimensions_x | the width must be specified in mm |
NO | |
| dimensions_y | the length must be stated in mm |
NO | |
| dimensions_z | the depth must be stated in mm |
NO | |
| trackingNumber | field to transmit the barcode |
NO | |
| documentNumber | number of the document / optional field |
NO | |
| documentDate | date of the document / optional field |
NO | |
| rawResult | field with raw result |
NO | |
| dimensions | filed for dimensions / optional field |
NO | |
| createdByDocument | field for specify the ID of acceptance document |
NO | |
| shippedByDocument | field for specify the ID of consumption document |
NO | |
| place | how many packages are needed for the order |
NO | |
| deliveryTasks | this field does not need to be filed |
NO | |
| outExtId | this is an optional field for out ext id |
NO | |
| places | field for transmitting the content of the delivery request |
NO | |
| comment | optional field for comment |
NO | |
| sendDate | date of sending the shipment |
NO | |
| senderProfile | the sender profile will be taken from the sender settings |
NO | |
| eav | eav attribute |
NO | |
| paymentState | NO | ||
| source | NO | ||
| deliveryServiceStatus | NO | ||
| rawData | NO | ||
| tracking | NO | ||
| volume | NO | ||
| order | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| 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\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/requests[/:delivery_request_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | state of the delivery request |
NO | |
| rate | rate of the delivery,need to specify the rate id |
YES | |
| currency | in example currency is in rubles, need to specify the currency id |
NO | |
| extId | extId should be unique |
NO | |
| clientExtId | an optional field |
NO | |
| deliveryService | object | Delivery service object |
NO |
| integration | object | Integration object |
NO |
| estimatedCost | estimated cost for the delivery request |
NO | |
| price | price of the order |
NO | |
| tax | Tax of the order |
NO | |
| retailPrice | Retail price of the delivery |
NO | |
| payment | the amount to be paid for shipment |
NO | |
| pickupDate | date on which the shipment will be handed to the delivery service |
NO | |
| sender | YES | ||
| sender | the sender ID should be specified |
NO | |
| senderAddress | the sender address will be taken from the sender settings |
NO | |
| senderName | the sender name will be taken from the sender settings |
NO | |
| senderPhone | the sender phone will be taken from the sender settings |
NO | |
| senderComment | the sender comment will be taken from the sender settings |
NO | |
| deliveryDate | date on which the shipment is expected to be delivered |
NO | |
| deliveryTimeStart | start time for delivery of the shipment |
NO | |
| deliveryTimeEnd | end time for delivery of the shipment |
NO | |
| recipient | name of the recipient |
NO | |
| recipientAddress | the recipient address should be transmitted in an array, entering - city, street, home, apartment, post code |
YES | |
| recipientRawAddress | raw type of recipient address |
NO | |
| recipientName | field for recipient name |
NO | |
| recipientPhone | Recipient phone number |
NO | |
| recipientComment | field for recipient comment |
NO | |
| recipientLocality | the recipient locality ID should be specified |
NO | |
| servicePoint | the service point ID should be specified |
NO | |
| weight | the weight should be specified in grams |
NO | |
| dimensions_x | the width must be specified in mm |
NO | |
| dimensions_y | the length must be stated in mm |
NO | |
| dimensions_z | the depth must be stated in mm |
NO | |
| trackingNumber | field to transmit the barcode |
NO | |
| documentNumber | number of the document / optional field |
NO | |
| documentDate | date of the document / optional field |
NO | |
| rawResult | field with raw result |
NO | |
| dimensions | filed for dimensions / optional field |
NO | |
| createdByDocument | field for specify the ID of acceptance document |
NO | |
| shippedByDocument | field for specify the ID of consumption document |
NO | |
| place | how many packages are needed for the order |
NO | |
| deliveryTasks | this field does not need to be filed |
NO | |
| outExtId | this is an optional field for out ext id |
NO | |
| places | field for transmitting the content of the delivery request |
NO | |
| comment | optional field for comment |
NO | |
| sendDate | date of sending the shipment |
NO | |
| senderProfile | the sender profile will be taken from the sender settings |
NO | |
| eav | eav attribute |
NO | |
| paymentState | NO | ||
| source | NO | ||
| deliveryServiceStatus | NO | ||
| rawData | NO | ||
| tracking | NO | ||
| volume | NO | ||
| order | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
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\delivery-services\api.v1+json
application/hal+json
application/json
application/xls
application/x-xls
application/*excel
application/pdf |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DeliveryRequestsService
GET /api/delivery-services/delivery-requests-service
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/delivery-requests-service
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/delivery-requests-service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/delivery-requests-service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/delivery-requests-service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/delivery-requests-service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /api/delivery-services/delivery-requests-service[/:service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DeliveryServiceCity
Delivery services city
GET /api/delivery-services/delivery-service-city
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
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
POST /api/delivery-services/delivery-service-city
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/delivery-service-city[/:delivery_service_city_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/delivery-service-city[/:delivery_service_city_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/delivery-service-city[/:delivery_service_city_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/delivery-service-city[/:delivery_service_city_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
CourierLocations
GET /api/delivery-services/delivery/courier-location
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/delivery/courier-location[/:courier_location_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Queues
GET /api/delivery-services/delivery/queue
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/delivery/queue
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/delivery/queue[/:queue_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/delivery/queue[/:queue_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/delivery/queue[/:queue_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Tasks
GET /api/delivery-services/delivery/task
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| queue | YES | ||
| deliveryRequest | NO | ||
| executive | NO | ||
| initialCoordinates | NO | ||
| finalCoordinates | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/delivery/task
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| queue | YES | ||
| deliveryRequest | NO | ||
| executive | NO | ||
| initialCoordinates | NO | ||
| finalCoordinates | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/delivery/task[/:task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| queue | YES | ||
| deliveryRequest | NO | ||
| executive | NO | ||
| initialCoordinates | NO | ||
| finalCoordinates | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/delivery/task[/:task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| queue | YES | ||
| deliveryRequest | NO | ||
| executive | NO | ||
| initialCoordinates | NO | ||
| finalCoordinates | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/delivery/task[/:task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| queue | YES | ||
| deliveryRequest | NO | ||
| executive | NO | ||
| initialCoordinates | NO | ||
| finalCoordinates | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DeliveryServiceReturn
GET /api/delivery-services/movements/delivery-service-returns
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/movements/delivery-service-returns
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/movements/delivery-service-returns
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/movements/delivery-service-returns
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
GET /api/delivery-services/movements/delivery-service-returns[/:delivery_service_return_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/movements/delivery-service-returns[/:delivery_service_return_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/movements/delivery-service-returns[/:delivery_service_return_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/movements/delivery-service-returns[/:delivery_service_return_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
DeliveryService
Delivery service methods
GET /api/delivery-services
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Delivery service id |
NO | |
| state | YES | ||
| rates | NO | ||
| name | YES | ||
| extId | YES | ||
| defaultRate | NO | ||
| defaultLocalityRate | NO | ||
| country | NO | ||
| logo | NO | ||
| adapter | NO | ||
| eav | NO | ||
| type | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Delivery service id |
NO | |
| state | YES | ||
| rates | NO | ||
| name | YES | ||
| extId | YES | ||
| defaultRate | NO | ||
| defaultLocalityRate | NO | ||
| country | NO | ||
| logo | NO | ||
| adapter | NO | ||
| eav | NO | ||
| type | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services[/:delivery_service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Delivery service id |
NO | |
| state | YES | ||
| rates | NO | ||
| name | YES | ||
| extId | YES | ||
| defaultRate | NO | ||
| defaultLocalityRate | NO | ||
| country | NO | ||
| logo | NO | ||
| adapter | NO | ||
| eav | NO | ||
| type | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services[/:delivery_service_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Delivery service id |
NO | |
| state | YES | ||
| rates | NO | ||
| name | YES | ||
| extId | YES | ||
| defaultRate | NO | ||
| defaultLocalityRate | NO | ||
| country | NO | ||
| logo | NO | ||
| adapter | NO | ||
| eav | NO | ||
| type | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
JobTask
GET /api/delivery-services/events/job-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| data | NO | ||
| timetable | NO | ||
| integration | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/events/job-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| data | NO | ||
| timetable | NO | ||
| integration | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| data | NO | ||
| timetable | NO | ||
| integration | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| data | NO | ||
| timetable | NO | ||
| integration | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| data | NO | ||
| timetable | NO | ||
| integration | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| data | NO | ||
| timetable | NO | ||
| integration | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Job
GET /api/delivery-services/events/jobs
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| integration | YES | ||
| state | YES | ||
| data | YES | ||
| result | YES | ||
| jobTask | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/events/jobs
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| integration | YES | ||
| state | YES | ||
| data | YES | ||
| result | YES | ||
| jobTask | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| integration | YES | ||
| state | YES | ||
| data | YES | ||
| result | YES | ||
| jobTask | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| integration | YES | ||
| state | YES | ||
| data | YES | ||
| result | YES | ||
| jobTask | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| integration | YES | ||
| state | YES | ||
| data | YES | ||
| result | YES | ||
| jobTask | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| integration | YES | ||
| state | YES | ||
| data | YES | ||
| result | YES | ||
| jobTask | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Integration
GET /api/delivery-services/integrations
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| name | NO | ||
| deliveryService | YES | ||
| sender | YES | ||
| comment | NO | ||
| settings | NO | ||
| parent | NO | ||
| action | NO | ||
| mode | NO | ||
| rates | NO | ||
| customProfile | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/integrations
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| name | NO | ||
| deliveryService | YES | ||
| sender | YES | ||
| comment | NO | ||
| settings | NO | ||
| parent | NO | ||
| action | NO | ||
| mode | NO | ||
| rates | NO | ||
| customProfile | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/integrations
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| name | NO | ||
| deliveryService | YES | ||
| sender | YES | ||
| comment | NO | ||
| settings | NO | ||
| parent | NO | ||
| action | NO | ||
| mode | NO | ||
| rates | NO | ||
| customProfile | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/integrations[/:integration_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| name | NO | ||
| deliveryService | YES | ||
| sender | YES | ||
| comment | NO | ||
| settings | NO | ||
| parent | NO | ||
| action | NO | ||
| mode | NO | ||
| rates | NO | ||
| customProfile | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/integrations[/:integration_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| name | NO | ||
| deliveryService | YES | ||
| sender | YES | ||
| comment | NO | ||
| settings | NO | ||
| parent | NO | ||
| action | NO | ||
| mode | NO | ||
| rates | NO | ||
| customProfile | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/integrations[/:integration_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | NO | ||
| name | NO | ||
| deliveryService | YES | ||
| sender | YES | ||
| comment | NO | ||
| settings | NO | ||
| parent | NO | ||
| action | NO | ||
| mode | NO | ||
| rates | NO | ||
| customProfile | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
MovementAcceptance
GET /api/delivery-services/movements/acceptance
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| taskState | NO | ||
| sender | YES | ||
| comment | NO | ||
| deliveryRequests | 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/delivery-services/movements/acceptance
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| taskState | NO | ||
| sender | YES | ||
| comment | NO | ||
| deliveryRequests | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/movements/acceptance[/:acceptance_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| taskState | NO | ||
| sender | YES | ||
| comment | NO | ||
| deliveryRequests | 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
POST /api/delivery-services/movements/acceptance[/:acceptance_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| taskState | NO | ||
| sender | YES | ||
| comment | NO | ||
| deliveryRequests | 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
DELETE /api/delivery-services/movements/acceptance[/:acceptance_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| taskState | NO | ||
| sender | YES | ||
| comment | NO | ||
| deliveryRequests | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
PATCH /api/delivery-services/movements/acceptance[/:acceptance_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| taskState | NO | ||
| sender | YES | ||
| comment | NO | ||
| deliveryRequests | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
MovementConsumption
GET /api/delivery-services/movements/consumption
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/movements/consumption
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
application/pdf
text/html |
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\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/movements/consumption
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
application/pdf
text/html |
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\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/movements/consumption
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
GET /api/delivery-services/movements/consumption[/:consumption_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/movements/consumption[/:consumption_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
application/pdf
text/html |
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\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/movements/consumption[/:consumption_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
application/pdf
text/html |
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\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/movements/consumption[/:consumption_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| sender | YES | ||
| creator | NO | ||
| deliveryService | YES | ||
| comment | NO | ||
| action | NO | ||
| exportResult | NO | ||
| criteria | NO | ||
| deliveryRequests | NO | ||
| eav | NO | ||
| extId | NO | ||
| shippingDate | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
application/document
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Payments
GET /api/delivery-services/payments
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| deliveryService | YES | ||
| sender | YES | ||
| deliveryRequest | YES | ||
| state | NO | ||
| status | NO | ||
| trackingNumber | YES | ||
| payment | YES | ||
| commission | YES | ||
| extId | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/payments
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| deliveryService | YES | ||
| sender | YES | ||
| deliveryRequest | YES | ||
| state | NO | ||
| status | NO | ||
| trackingNumber | YES | ||
| payment | YES | ||
| commission | YES | ||
| extId | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/payments
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| deliveryService | YES | ||
| sender | YES | ||
| deliveryRequest | YES | ||
| state | NO | ||
| status | NO | ||
| trackingNumber | YES | ||
| payment | YES | ||
| commission | YES | ||
| extId | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/payments[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| deliveryService | YES | ||
| sender | YES | ||
| deliveryRequest | YES | ||
| state | NO | ||
| status | NO | ||
| trackingNumber | YES | ||
| payment | YES | ||
| commission | YES | ||
| extId | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/payments[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| deliveryService | YES | ||
| sender | YES | ||
| deliveryRequest | YES | ||
| state | NO | ||
| status | NO | ||
| trackingNumber | YES | ||
| payment | YES | ||
| commission | YES | ||
| extId | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/payments[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| deliveryService | YES | ||
| sender | YES | ||
| deliveryRequest | YES | ||
| state | NO | ||
| status | NO | ||
| trackingNumber | YES | ||
| payment | YES | ||
| commission | YES | ||
| extId | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Payout
GET /api/delivery-services/payouts
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| integration | YES | ||
| currency | YES | ||
| rate | NO | ||
| amount | NO | ||
| paymentOrderNumber | NO | ||
| date | NO | ||
| report | NO | ||
| comment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/payouts
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| integration | YES | ||
| currency | YES | ||
| rate | NO | ||
| amount | NO | ||
| paymentOrderNumber | NO | ||
| date | NO | ||
| report | NO | ||
| comment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/payouts
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| integration | YES | ||
| currency | YES | ||
| rate | NO | ||
| amount | NO | ||
| paymentOrderNumber | NO | ||
| date | NO | ||
| report | NO | ||
| comment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/payouts[/:payout_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| integration | YES | ||
| currency | YES | ||
| rate | NO | ||
| amount | NO | ||
| paymentOrderNumber | NO | ||
| date | NO | ||
| report | NO | ||
| comment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/payouts[/:payout_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| integration | YES | ||
| currency | YES | ||
| rate | NO | ||
| amount | NO | ||
| paymentOrderNumber | NO | ||
| date | NO | ||
| report | NO | ||
| comment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/payouts[/:payout_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| integration | YES | ||
| currency | YES | ||
| rate | NO | ||
| amount | NO | ||
| paymentOrderNumber | NO | ||
| date | NO | ||
| report | NO | ||
| comment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PickupAddress
GET /api/delivery-services/pickups/address
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| owner | NO | ||
| locality | YES | ||
| price | NO | ||
| postcode | NO | ||
| streetPrefix | NO | ||
| street | NO | ||
| house | NO | ||
| block | NO | ||
| apartment | NO | ||
| notFormal | NO | ||
| state | NO |
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
POST /api/delivery-services/pickups/address
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| owner | NO | ||
| locality | YES | ||
| price | NO | ||
| postcode | NO | ||
| streetPrefix | NO | ||
| street | NO | ||
| house | NO | ||
| block | NO | ||
| apartment | NO | ||
| notFormal | NO | ||
| state | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json
application/*+json |
| Content-Type | 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/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/pickups/address[/:address_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| owner | NO | ||
| locality | YES | ||
| price | NO | ||
| postcode | NO | ||
| streetPrefix | NO | ||
| street | NO | ||
| house | NO | ||
| block | NO | ||
| apartment | NO | ||
| notFormal | NO | ||
| state | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/pickups/address[/:address_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| owner | NO | ||
| locality | YES | ||
| price | NO | ||
| postcode | NO | ||
| streetPrefix | NO | ||
| street | NO | ||
| house | NO | ||
| block | NO | ||
| apartment | NO | ||
| notFormal | NO | ||
| state | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json
application/*+json |
| Content-Type | 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/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/pickups/address[/:address_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| owner | NO | ||
| locality | YES | ||
| price | NO | ||
| postcode | NO | ||
| streetPrefix | NO | ||
| street | NO | ||
| house | NO | ||
| block | NO | ||
| apartment | NO | ||
| notFormal | NO | ||
| state | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json
application/*+json |
| Content-Type | 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/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PickupItinerary
GET /api/delivery-services/pickups-itinerary
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| comment | YES | ||
| deliveryService | NO | ||
| sender | NO | ||
| date | 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
POST /api/delivery-services/pickups-itinerary
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| comment | YES | ||
| deliveryService | NO | ||
| sender | NO | ||
| date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/pickups-itinerary[/:pickup_itinerary_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| comment | YES | ||
| deliveryService | NO | ||
| sender | NO | ||
| date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/pickups-itinerary[/:pickup_itinerary_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| comment | YES | ||
| deliveryService | NO | ||
| sender | NO | ||
| date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/pickups-itinerary[/:pickup_itinerary_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| comment | YES | ||
| deliveryService | NO | ||
| sender | NO | ||
| date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/pickups-itinerary[/:pickup_itinerary_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| comment | YES | ||
| deliveryService | NO | ||
| sender | NO | ||
| date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Pickup
Delivery services pickup
GET /api/delivery-services/pickups
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| pickupDate | YES | ||
| senderAddress | YES | ||
| sender | YES | ||
| owner | YES | ||
| senderPhone | YES | ||
| state | NO | ||
| pickupTimeStart | YES | ||
| pickupTimeEnd | NO | ||
| countParcels | NO | ||
| weight | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| senderName | YES | ||
| senderEmail | NO | ||
| isTimetable | NO | ||
| timetable | NO | ||
| contactPerson | NO | ||
| comment | NO | ||
| price | NO | ||
| volume | NO | ||
| isSkipWeekend | 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
POST /api/delivery-services/pickups
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| pickupDate | YES | ||
| senderAddress | YES | ||
| sender | YES | ||
| owner | YES | ||
| senderPhone | YES | ||
| state | NO | ||
| pickupTimeStart | YES | ||
| pickupTimeEnd | NO | ||
| countParcels | NO | ||
| weight | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| senderName | YES | ||
| senderEmail | NO | ||
| isTimetable | NO | ||
| timetable | NO | ||
| contactPerson | NO | ||
| comment | NO | ||
| price | NO | ||
| volume | NO | ||
| isSkipWeekend | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/pickups[/:pickup_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| pickupDate | YES | ||
| senderAddress | YES | ||
| sender | YES | ||
| owner | YES | ||
| senderPhone | YES | ||
| state | NO | ||
| pickupTimeStart | YES | ||
| pickupTimeEnd | NO | ||
| countParcels | NO | ||
| weight | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| senderName | YES | ||
| senderEmail | NO | ||
| isTimetable | NO | ||
| timetable | NO | ||
| contactPerson | NO | ||
| comment | NO | ||
| price | NO | ||
| volume | NO | ||
| isSkipWeekend | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/pickups[/:pickup_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| pickupDate | YES | ||
| senderAddress | YES | ||
| sender | YES | ||
| owner | YES | ||
| senderPhone | YES | ||
| state | NO | ||
| pickupTimeStart | YES | ||
| pickupTimeEnd | NO | ||
| countParcels | NO | ||
| weight | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| senderName | YES | ||
| senderEmail | NO | ||
| isTimetable | NO | ||
| timetable | NO | ||
| contactPerson | NO | ||
| comment | NO | ||
| price | NO | ||
| volume | NO | ||
| isSkipWeekend | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/delivery-services/pickups[/:pickup_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| pickupDate | YES | ||
| senderAddress | YES | ||
| sender | YES | ||
| owner | YES | ||
| senderPhone | YES | ||
| state | NO | ||
| pickupTimeStart | YES | ||
| pickupTimeEnd | NO | ||
| countParcels | NO | ||
| weight | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| senderName | YES | ||
| senderEmail | NO | ||
| isTimetable | NO | ||
| timetable | NO | ||
| contactPerson | NO | ||
| comment | NO | ||
| price | NO | ||
| volume | NO | ||
| isSkipWeekend | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| 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 | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PlaceItems
GET /api/delivery-services/place-items
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/place-items
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/place-items
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/place-items
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
PUT /api/delivery-services/place-items
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/place-items[/:place_items_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/place-items[/:place_items_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/place-items[/:place_items_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/delivery-services/place-items[/:place_items_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| extId | NO | ||
| deliveryRequest | NO | ||
| place | YES | ||
| orderProduct | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| name | YES | ||
| payment | NO | ||
| count | YES | ||
| tax | NO | ||
| price | NO | ||
| estimatedCost | NO | ||
| image | NO | ||
| barcodes | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Places
GET /api/delivery-services/places
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| state | NO | ||
| eav | NO | ||
| deliveryRequest | YES | ||
| place | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| priority | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/places
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| state | NO | ||
| eav | NO | ||
| deliveryRequest | YES | ||
| place | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| priority | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/places
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| state | NO | ||
| eav | NO | ||
| deliveryRequest | YES | ||
| place | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| priority | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/places[/:places_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| state | NO | ||
| eav | NO | ||
| deliveryRequest | YES | ||
| place | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| priority | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/places[/:places_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| state | NO | ||
| eav | NO | ||
| deliveryRequest | YES | ||
| place | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| priority | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/places[/:places_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extId | NO | ||
| state | NO | ||
| eav | NO | ||
| deliveryRequest | YES | ||
| place | NO | ||
| dimensions | NO | ||
| volume | NO | ||
| weight | NO | ||
| priority | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Postcode
GET /api/delivery-services/postcodes
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| country | YES | ||
| locality | YES | ||
| extId | YES | ||
| state | YES | ||
| geo | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/postcodes
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| country | YES | ||
| locality | YES | ||
| extId | YES | ||
| state | YES | ||
| geo | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/postcodes
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| country | YES | ||
| locality | YES | ||
| extId | YES | ||
| state | YES | ||
| geo | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/postcodes[/:postcode_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| country | YES | ||
| locality | YES | ||
| extId | YES | ||
| state | YES | ||
| geo | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/postcodes[/:postcode_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| country | YES | ||
| locality | YES | ||
| extId | YES | ||
| state | YES | ||
| geo | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/postcodes[/:postcode_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| country | YES | ||
| locality | YES | ||
| extId | YES | ||
| state | YES | ||
| geo | NO | ||
| raw | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
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\delivery-services\api.v1+json
application/hal+json
application/json
multipart/form-data |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PreprocessingQueue
Delivery request preprocessing queues
GET /api/delivery-services/preprocessing-queue
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/preprocessing-queue
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/preprocessing-queue
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/delivery-services/preprocessing-queue[/:preprocessing_queue_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/delivery-services/preprocessing-queue[/:preprocessing_queue_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |
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\delivery-services\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/delivery-services/preprocessing-queue[/:preprocessing_queue_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\delivery-services\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\delivery-services\api.v1+json
application/json |