Open Inventory / Docs
EndpunkteOrdersOrdersOrderidShipments

Create an outbound parcel from fulfilled sales-order lines

Die API läuft auf deiner Anwendungsinstanz. Schemas und Feldnamen stammen unverändert aus der OpenAPI-Spezifikation. Browsergebundene Aufrufe benötigen eine Sitzung auf der Instanz.

POST
/orders/{orderId}/shipments

Assigns fulfilled bulk quantities and concrete serialized units to a parcel. This endpoint records Inventory shipping data and does not write to WooCommerce.

Authentifizierung

bearerAuth
headerAuthentifizierungBearer <inv_ token>

Pfadparameter

orderId*string
Formatuuid

Header-Parameter

Idempotency-Key*string

UUID identifying this atomic operation; reuse it only to retry the exact same request.

Formatuuid
X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Anfrageinhalt

application/json
  1. body
carrierCode*string
Muster^[a-z0-9][a-z0-9_-]{0,39}$
service?|
Länge1 <= length <= 120
trackingNumber?|
Länge1 <= length <= 180
trackingUrl?|

HTTPS only. Known carriers receive a default URL when omitted.

Formaturi
Längelength <= 2048
status?string
Standard"draft"
Mögliche Werte"draft""ready"
note?string
Längelength <= 20000
lines*array<>
Einträge1 <= items <= 100

Antwortinhalt

Replayed the original shipment response

Beispielanfrage
curl -X POST 'https://inventory.example.com/api/v1/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/shipments' \  -H 'Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "carrierCode": "string",  "lines": [    {      "orderLineId": "3bba51e3-a0c1-4b14-a700-b2d3b8ed156d",      "quantity": 1    }  ]}'
Beispielantwort
Leer