Creation of Expedition
Create Expedition
Create a new expedition entity to the database.
Request structure
Endpoint: | |
URL (prod): | |
Headers: |
CODE
|
Request body: | For detailed request body specifications, please refer to our API Doc. |
Request Example (cURL): |
CODE
|
Request body specifications
Here is an additional, more detailed explanation of certain fields:
Field | Description |
---|---|
| ID of your e-shop. Retrieve available e-shop IDs via POST /api/eshop/list. |
| ID of your warehouse. Retrieve available warehouse IDs via POST /api/warehouse/list. Warehouse is your physical warehouse. |
| ID of your wms. A wms entity represents a virtual warehouse linked to a physical warehouse. It tracks inventory, stock movements, and shipments within the system, ensuring accurate stock records. Retrieve your wms ID via POST /api/warehouse/list. |
| You can create a See more for partners in Knowledge Base or API Doc. |
| Boolean. If |
| ID of the carrier. Retrieve available carrier IDs via POST /api/carrier/list. For more information please see Carrier section. |
| ID of the carrier service. Retrieve available carrier services IDs via POST /api/carrier-service/list. |
| ID of the carrier pickup places. Retrieve available carrier pickup places via POST /api/carrier-pickup-place/list. |
| Code of the pickup place on the carrier's side. Example values:
|
| ID of the external carrier pickup places. Retrieve available carrier external pickup places via POST /api/external-carrier-pickup-place/list. |
| Code of the external pickup place on the carrier's side. Example value:
|
| Boolean. Indicates if cash-on-delivery is required. |
| Fields must be |
| Array of products included in the expedition. |
| Boolean. Puts the status “to_be_confirmed“ on the order. Useful for pending payments. The expedition stays in this status until it is manually sent via PUT /api/expedition/{id}/send, triggering processing in WMS. |
| Boolean. Puts the status “on_hold” on the order, allowing edits before sending to WMS. The expedition stays in this status until it is manually sent via PUT /api/expedition/{id}/send, triggering processing in WMS. |
| Boolean. Default: |
| Includes the field |
| Specialized expedition service. For more information, contact our customer support team. |
For additional field informations, refer to the Knowledge Base or API doc.
These fields are not supported and should be excluded when creating an expedition.
"user"
"status"
"expeditedCompletely"
"invoice"
"createdAt"
"parcels"
"countOfItems"
"countOfSku"
"sumOfQuantity"
"errors"
"packedAt"
"sentAt"
"deliveredAt"
"foreignPrice"
"conversionDate"
"modifiedAt"
"removedVirtualProducts"
"addressValidationExecuted"
"changedAt"
"dcCodeOfOrigin"
"hasDuplicatePositions"
"withComplaint"
"trackingNumber"
"trackingUrl"
"genericTrackingUrl"
"externalTrackingNumber"
"packagesCount"
"priority"
Response
If successful, the API returns the newly created expedition entity in JSON format.
See more details in the API Doc.