Skip to content

Update fulfillments of fulfillment order

POST
/merchants/{merchantCode}/fulfillmentOrders/{orderNumber}/fulfillments/{fulfillmentId}
curl --request POST \
--url https://order.shopgate.io/v1/merchants/example/fulfillmentOrders/example/fulfillments/example \
--header 'Content-Type: application/json' \
--data '{ "status": "open", "carrier": "DHL", "serviceLevel": "sameDay", "tracking": "JJD000390007882823450", "fulfillmentPackages": [ { "id": 537, "status": "open", "serviceLevel": "sameDay", "package": "small", "fulfilledFromLocationCode": "DERetail001", "weight": 2000, "weightUnit": "g", "dimensions": { "length": 25, "lengthUnit": "mm", "width": 17.5, "widthUnit": "mm", "height": 10, "heightUnit": "mm" }, "tracking": "JJD000390007882823450", "pickUpBy": "Kim Muster", "labelUrl": "https://documentserver.internal/label/label.pdf", "labelType": "pdf", "fulfillmentDate": "2026-04-15T12:00:00Z", "packageItems": [ { "salesOrderLineItemCode": "386", "quantity": 1 } ] } ] }'

Update fulfillments of fulfillment order

merchantCode
required
string

Unique merchant code which represents the unique “merchant account”.

orderNumber
required
string

Unique order number

fulfillmentId
required
string

The ID of the fulfillment

Media typeapplication/json
object
status
string
Allowed values: open canceled inProgress fulfilled
carrier
string
Example
DHL
serviceLevel
string
Example
sameDay
tracking
string
Example
JJD000390007882823450
fulfillmentPackages
Array<object>
object
id
number
Example
537
status
string
default: open
Allowed values: open inProgress readyForPickup inTransit fulfilled canceled
serviceLevel
string
Example
sameDay
package
string
Example
small
fulfilledFromLocationCode
string
Example
DERetail001
weight

The actual package weight.

number format: float
Example
2000
weightUnit
string
Allowed values: g lb
dimensions
object
length
number format: float
Example
25
lengthUnit
string
Allowed values: mm cm in
Example
cm
width
number format: float
Example
17.5
widthUnit
string
Allowed values: mm cm in
Example
cm
height
number format: float
Example
10
heightUnit
string
Allowed values: mm cm in
Example
cm
tracking
string
Example
JJD000390007882823450
pickUpBy
string
Example
Kim Muster
labelUrl
string
Example
https://documentserver.internal/label/label.pdf
labelType
string
Allowed values: pdf zpl
fulfillmentDate

The date and time of the package entering status “inTransit” or “fulfilled”.

string format: date-time
packageItems
Array<object>
object
salesOrderLineItemCode
required
string
Example
386
quantity
required
number
key
additional properties
any

Fulfillment updated

Media typeapplication/json

Merchant, fulfillment order or fulfillment not found

Media typeapplication/json