API Reference

List shipments

get
https://{merchant}.fulfil.io/services/3pl/v1/customer-shipments.json

Returns a list of shipments (max. 100 shipments per page).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The default behavior is to return pending shipments (that have not been acknowledged). You can also request open (acknowledged, but not shipped) or done shipments.

🚧

On-hold shipments

If a shipment has been marked as on-hold in Fulfil, it will not be exposed in the list of shipments available to a 3PL

Path Params
string
required
Defaults to demo

The merchant_Id (subdomain) of your fulfil instance

Query Params
date

Show shipments to be shipped on or after this date (format: 2020-05-01)

date

Show shipments to be shipped on or before this date (format: 2020-05-01)

string
enum
Defaults to pending
Allowed:
string

"," separated list of ids

string

"," separated list of shipment numbers. This must be an exact match (case sensitive)

string

filter shipments only for the specific carrier service code

string
Defaults to 1

You can go to a specific page by specifying the number, a maximum of 100 records will be returned in data

Responses

Updated about 2 months ago

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

Updated about 2 months ago