Create sales order fulfillment groups

POST

/merchants/{merchantCode}/orders/{orderNumber}/fulfillmentGroups

curl --request POST \
  --url https://order.shopgate.io/v1/merchants/example/orders/example/fulfillmentGroups \
  --header 'Content-Type: application/json' \
  --data '{ "fulfillmentGroups": [ { "fulfillmentMethod": "directShip", "fulfillmentLocationCode": "example", "shipToAddressSequenceIndex": 1, "fulfillments": [ { "status": "open", "carrier": "DHL", "serviceLevel": "sameDay", "tracking": "JJD000390007882823450", "fulfillmentPackages": [ { "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 } ] } ] } ] } ] }'

Create sales order fulfillment groups

Parameters

Path Parameters

merchantCode

required

string

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

orderNumber

required

string

Unique order number

Request Body

Media typeapplication/json

object

fulfillmentGroups

Array<object>

object

fulfillmentMethod

required

string

Allowed values: directShip BOPIS ROPIS

Example

ROPIS

fulfillmentLocationCode

string

shipToAddressSequenceIndex

number

fulfillments

required

Array<object>

object

status

required

string

Allowed values: open canceled inProgress fulfilled

carrier

string

Example

DHL

serviceLevel

string

Example

sameDay

tracking

string

Example

JJD000390007882823450

fulfillmentPackages

required

Array<object>

object

status

string

default: open

Allowed values: open inProgress readyForPickup inTransit fulfilled canceled

serviceLevel

string

Example

sameDay

package

string

Example

small

fulfilledFromLocationCode

required

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

required

Array<object>

object

salesOrderLineItemCode

required

string

Example

386

quantity

required

number

key

additional properties

any

Responses

201

Fulfillments created

Media typeapplication/json

object

ids

Array<number>

errors

Array<object>

object

entityIndex

number

entity

string

entityId

string

code

number

message

string

subentityPath

Array<string | null | number>

Example

{
  "ids": [
    100
  ]
}