Get Started

Create sale fulfilment

Opens a fulfilment for a completed sale. Defaults to Awaiting dispatch.

POSThttps://api.tracksales.co/v1/sales/{uuid}/fulfilment

Create the sale with POST /sales first, using salesChannel online. Then call this endpoint with the sale uuid from that response. A new fulfilment is saved with status draft, which the fulfilment screen shows as Awaiting dispatch. Calling create again for the same sale returns the existing fulfilment.

Required scope: fulfilments:create

Request URL: https://api.tracksales.co/v1/sales/{uuid}/fulfilment

Path Params

uuidstringrequired

Sale UUID returned by Create sale

Body Params

deliveryAddressstring

Shipping address. Falls back to the customer address on the sale when omitted.

deliveryZonestring

Delivery zone name. Must match a Tracksales zone such as CBD & Central or Westlands–Waiyaki Way. Unknown values are ignored.

notesstring

Note stored on the fulfilment, such as the storefront order number.

fulfilmentTypestring

delivery or pickup. Defaults to the organization fulfilment type, usually delivery.

Responses

201Created

Fulfilment created with status draft (Awaiting dispatch).

200OK

A fulfilment already exists for this sale. The existing record is returned.

401Unauthorized

API key is missing or invalid.

403Forbidden

API key lacks the required scope.

404Not Found

Fulfilment was not found.

422Validation Error

Request validation failed.