GuidesAPI Reference
Log In
API Reference

Create Fulfillment

Send the details of a new fulfillment to Delivery Hub from your Order Management System (OMS).

Path Params
double
required
Body Params
string

Your source system's ID for this fulfillment.

products
array of objects
required

The products included in this fulfillment.

products*
string
enum

Designates if this is a delivery or return.

Allowed:
shipments
array of objects

The shipments included in this fulfillment.

shipments
double

The shipping account used for the quoted or actual booking. Required when service is present. This is used when the end-customer selects the carrier and service for a shipment.

string

The service level for the quoted booking, such as same-day. Required shipping_account_id is present.

sender
object
recipient
object
sender_address
object
recipient_address
object
double

The ID of the location where the fulfillment is being sent from. This is used to determine the origin of the shipment. If not provided, the sender and sender_address must be provided.

double

Delivery Hub's or your source system's ID for the recipient's location. Forbidden if recipient or recipient_address are present.

string
enum

Designates if the fulfillment method is direct delivery to the recipient's address or via a PUDO (pickup/dropoff) location.

Allowed:
string

The ID of the PUDO (pickup/drop off) location of the sender or recipient.

Headers
string
required
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json