List fulfillments or shipments from vendors

Gets a list of fulfillments or shipments that contain details about the variants included in the shipment along with the tracking number. Generally, the is_acknowledged=0 is passed as a query to return only new shipments not yet processed by the retailer.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retailer_pk

number

required

Retailer ID

Query Parameters

status

string

Shipment status

is_acknowledged

number

1: shipment is picked up <br /> 0: shipment is not picked up

search

string

Search by tracking or purchase order number

order_id

number[]

Order IDs. Multiple values may be separated by commas.

since

number

Past date till current (Unix epoch format)

connection_id

number[]

Connection ID. Multiple values may be separated by commas.

order_by

string

Sorting preference

page

integer

Page number within the paginated result set

limit

integer

Number of records per page

Response

200 - application/json

count

integer

required

Total number of records

results

object[]

required

Show child attributes

results.order_id

integer

required

Order ID

results.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.batch_number

integer | null

Batch number of shipment

Required range: -2147483648 < x < 2147483647

results.brand

object

Show child attributes

results.brand.code

string

required

Vendor code, which is vendor name in lower case and underscore

Required string length: 1 - 64

results.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.brand.id

integer

Vendor (brand) ID

results.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

results.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

results.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.brand.name

string

Vendor name

Required string length: 1 - 64

results.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

results.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

results.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

results.brand.website

string | null

URL of brand website

Maximum length: 100

results.canceled_at

string | null

Time of cancellation (UTC format)

results.closed_at

string | null

Time of shipment closure (UTC format)

results.created_at

string

Time of shipment creation (UTC format)

results.customer_order_number

string

Customer order number

Minimum length: 1

results.delivered_at

string | null

Time of delivery (UTC format)

results.error_logs

object

Show child attributes

results.error_logs.count

integer

Count of error log

results.error_logs.created_at

string

Time of error log creation

results.error_logs.id

integer

Error log ID

results.error_logs.message

string | null

Message in error log

results.has_commercial_invoice

boolean

true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice

results.id

integer

Shipment ID

results.invoice_number

string

Invoice number

results.is_acknowledged

boolean

true: Shipment is acknowledged <br /> false: Shipment is not acknowledged

results.label_reference

string | null

Label reference

Maximum length: 30

results.ordered_at

string

Time of shipment creation (UTC format)

results.purchase_order_number

string

Purchase order number

Minimum length: 1

results.retailer_order_number

string

Retailer order number

Minimum length: 1

results.ship_from

object

Show child attributes

results.ship_from.city

string

required

City name

Required string length: 1 - 64

results.ship_from.country

string

required

Country name

Required string length: 1 - 128

results.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

results.ship_from.province

string

required

State name

Required string length: 1 - 32

results.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.ship_from.email

string | null

Contact email address

Maximum length: 128

results.ship_from.fax

string | null

Fax number

Maximum length: 32

results.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.ship_from.id

integer

Address ID

results.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

results.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

results.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

results.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.ship_girth

string

Shipment girth

results.ship_height

number | null

Shipment height

results.ship_length

number | null

Shipment length

results.ship_to

object

Show child attributes

results.ship_to.city

string

required

City name

Required string length: 1 - 64

results.ship_to.country

string

required

Country name

Required string length: 1 - 128

results.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.ship_to.province

string

required

State name

Required string length: 1 - 32

results.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.ship_to.email

string | null

Contact email address

Maximum length: 128

results.ship_to.fax

string | null

Fax number

Maximum length: 32

results.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.ship_to.id

integer

Address ID

results.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

results.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.ship_volume

string

Shipment volume

results.ship_weight

number | null

Shipment weight

results.ship_width

number | null

Shipment width

results.shipment_lines

object[]

Show child attributes

results.shipment_lines.freight_class

enum<string> | null

Freight class

Available options:

50,

55,

60,

65,

70,

77.5,

85,

92.5,

100,

110,

125,

150,

175,

200,

250,

300,

400,

500

results.shipment_lines.id

integer

Shipment line ID

results.shipment_lines.order_line_number

string

Order line number

results.shipment_lines.part

integer

Internal only

Required range: -2147483648 < x < 2147483647

results.shipment_lines.quantity

integer

Order quantity

Required range: -2147483648 < x < 2147483647

results.shipment_lines.updated_at

string

Time of last update

results.shipment_lines.variant

object

Show child attributes

results.shipment_lines.variant.brand

object

Show child attributes

results.shipment_lines.variant.brand.code

string

required

Vendor code. Same as vendor name in lower case and hyphenated

Required string length: 1 - 64

results.shipment_lines.variant.brand.id

integer

Vendor ID

results.shipment_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

results.shipment_lines.variant.brand_identifier

string

Brand identifier

Minimum length: 1

results.shipment_lines.variant.id

integer

Variant ID

results.shipment_lines.variant.identifier

string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 128

results.shipment_lines.variant.name

string | null

Variant name

Maximum length: 200

results.shipment_lines.variant.retailer_identifiers

object[]

Show child attributes

results.shipment_lines.variant.retailer_identifiers.id

integer

Retailer ID

results.shipment_lines.variant.retailer_identifiers.identifier

string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 256

results.shipment_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

results.shipment_lines.variant.retailer_identifiers.retailer

object

Show child attributes

results.shipment_lines.variant.upc

string

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your drop-shipping store

Maximum length: 64

results.shipped_at

string | null

Time of shipping (UTC format)

results.shipping_account

object

Show child attributes

results.shipping_account.nickname

string

required

Nickname of shipping account

Required string length: 1 - 64

results.shipping_account.carrier

object

Show child attributes

results.shipping_account.carrier.code

string

Carrier code

Required string length: 1 - 64

results.shipping_account.carrier.id

integer

Carrier ID

results.shipping_account.carrier.name

string

Carrier name

Required string length: 1 - 64

results.shipping_account.id

integer

Shipping account ID

results.shipping_account.is_first_party_bill

boolean

true: is first party billed shipment <br /> false Is not first party bill

results.shipping_account.owner

string

Owner of shipping account

results.shipping_method

object

Show child attributes

results.shipping_method.code

string

required

Code of shipping method

Required string length: 1 - 64

results.shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 64

results.shipping_method.carrier

object

Show child attributes

results.shipping_method.carrier.code

string

Carrier code

Required string length: 1 - 64

results.shipping_method.carrier.id

integer

Carrier ID

results.shipping_method.carrier.name

string

Carrier name

Required string length: 1 - 64

results.shipping_method.generic_shipping_method

object

Show child attributes

results.shipping_method.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

results.shipping_method.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

results.shipping_method.generic_shipping_method.id

integer

ID of shipping method

results.shipping_method.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.shipping_method.id

integer

ID of shipping method

results.shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum length: 64

results.signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

results.sold_to

object

Show child attributes

results.sold_to.city

string

required

City name

Required string length: 1 - 64

results.sold_to.country

string

required

Country name

Required string length: 1 - 128

results.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.sold_to.province

string

required

State name

Required string length: 1 - 32

results.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.sold_to.email

string | null

Contact email address

Maximum length: 128

results.sold_to.fax

string | null

Fax number

Maximum length: 32

results.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.sold_to.id

integer

Address ID

results.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

results.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.status

string

Status of shipment

Minimum length: 1

results.tracking

object

Show child attributes

results.tracking.delivered_at

string | null

Time of order delivery

results.tracking.picked_up_at

string | null

Time of order pickup

results.tracking.tracking_details

object[]

Show child attributes

results.tracking.tracking_details.status

string

required

Tracking status

Required string length: 1 - 32

results.tracking.tracking_details.status_detail

string

required

Status details

Required string length: 1 - 64

results.tracking.tracking_details.Time

string

required

Time of tracking (UTC format)

results.tracking.tracking_details.city

string | null

City of delivery

Maximum length: 32

results.tracking.tracking_details.country

string | null

Country of delivery

Maximum length: 8

results.tracking.tracking_details.id

integer

Tracking ID

results.tracking.tracking_details.postal_code

string | null

Postal code for delivery

Maximum length: 16

results.tracking.tracking_details.state

string | null

State of delivery

Maximum length: 8

results.tracking_number

string | null

Tracking number for shipment

Maximum length: 128

results.tracking_url

string

URL for tracking shipment

results.updated_at

string

Time of shipment update (UTC format)

results.valid_packing_slip

boolean

true: Shipment has valid packing slip <br /> false: Shipment does not valid packing slip

results.valid_shipping_label

boolean

true: Shipment has valid shipping label <br /> false: Shipment does not valid valid shipping label

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)