Merchants
- Overview
- Dropship Integrations
- Integrations
- Orders
- Products
- Suppliers
- Reports
- Settings
- Support
Merchant API Endpoints
- Authentication in Dropship
- Carriers
- Compliance Reports
- Connection Invites
- Inventory
- Invoices
- Orders
- Products
- Proposals
- Returns
- Shipments
- Webhooks
Suppliers
- Overview
- Getting Started
- Integrations
- Orders
- Products
- Reports
- Settings
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.
curl --request GET \
--url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/ \
--header 'Authorization: Bearer <token>'
{
"count": 600,
"next": "https://api.example.org/demo/{retailer_id}/?page=5",
"previous": "https://api.example.org/demo/{retailer_id}/?page=3",
"results": [
{
"id": 767,
"order_id": 677,
"batch_number": 6,
"label_reference": "Sample label 123",
"ordered_at": "2021-09-10T15:24:56Z",
"customer_order_number": "765637",
"retailer_order_number": "66367",
"purchase_order_number": "PO-576",
"shipping_method": {
"id": 5,
"name": "White Glove Bronze",
"code": "cory_white_glove",
"type": "ltl (less than truck load)",
"carrier": {
"id": 229,
"name": "Cory Companies",
"code": "CJCD"
},
"generic_shipping_method": {
"id": 5,
"name": "LTL",
"description": "Less than truckload (LTL)",
"type": "ltl"
}
},
"shipping_account": {
"id": 3,
"nickname": "Hobie FedEx",
"owner": "Sample Owner",
"carrier": {
"id": 229,
"name": "Cory Companies",
"code": "CJCD"
},
"is_first_party_bill": true
},
"tracking_number": "1Z9999999999999988",
"tracking_url": "https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988",
"tracking": {
"picked_up_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z",
"tracking_details": [
{
"id": 78895456,
"time": "10-10-2022",
"status": "Delivered",
"status_detail": "Out for delivery",
"country": "USA",
"state": "New York",
"city": "New York",
"postal_code": "123R32"
}
]
},
"status": "Shipped",
"is_acknowledged": true,
"has_commercial_invoice": true,
"canceled_at": null,
"sold_to": {
"id": 10,
"type": "residential",
"name1": "Demo Brand, Inc",
"name2": null,
"street1": "1332 Hermosa Ave",
"street2": null,
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US",
"phone1": "3105551212",
"phone2": "3105551213",
"fax": null,
"email": null,
"federal_tax_id": null
},
"ship_to": {
"id": 10,
"type": "residential",
"name1": "Demo Brand, Inc",
"name2": null,
"street1": "1332 Hermosa Ave",
"street2": null,
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US",
"phone1": "3105551212",
"phone2": "3105551213",
"fax": null,
"email": null,
"federal_tax_id": null
},
"ship_from": {
"id": 10,
"type": "residential",
"name1": "Demo Brand, Inc",
"name2": null,
"street1": "1332 Hermosa Ave",
"street2": null,
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US",
"phone1": "3105551212",
"phone2": "3105551213",
"fax": null,
"email": null,
"federal_tax_id": null
},
"ship_weight": 10,
"ship_width": 1,
"ship_length": 1,
"ship_height": 1,
"ship_girth": "<string>",
"ship_volume": 4,
"valid_packing_slip": true,
"valid_shipping_label": true,
"shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
"error_logs": {
"id": 677,
"message": "Sample errors to fix",
"count": 12,
"created_at": "2022-08-10T15:24:56Z"
},
"acknowledged_at": "2022-08-10T15:24:56Z",
"closed_at": null,
"delivered_at": "2022-09-10T15:24:56Z",
"shipped_at": "2022-09-10T15:24:56Z",
"updated_at": "2022-09-10T15:25:56Z",
"created_at": "2022-09-10T15:24:56Z",
"shipment_lines": [
{
"id": 1001,
"order_line_number": "1001",
"quantity": 1,
"part": 1,
"freight_class": 50,
"updated_at": "2022-09-10T15:24:56Z",
"variant": {
"id": 249,
"name": "Var45",
"brand": {
"id": 456,
"code": "marla-store",
"name": "Marla Store"
},
"identifier": "123-DEF12345",
"brand_identifier": "HATR",
"upc": 555555555202,
"retailer_identifiers": [
{
"id": 5642,
"retailer": {
"id": 500,
"name": "Demo Retailer",
"code": "demo-retailer",
"logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
"cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
"profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
"joined_at": "2021-08-03T17:24:12Z",
"is_rcn_retailer": false,
"is_onboarded": false,
"platform": "fabric",
"requires_subscription": "disabled",
"brand_permit_creation_allowed": false,
"website": "https://demoabc.com",
"status": "active"
},
"identifier": "SKU976",
"name": "Retailer Sample"
}
]
}
}
],
"signature": null,
"brand": {
"id": 500,
"name": "Marla Cielo",
"code": "demo-brand",
"joined_at": "2022-09-10T15:24:56Z",
"logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png",
"cover_url": "https://images.revcascade.com/retailers/defaults/cover.png",
"profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png",
"website": null,
"is_onboarded": false,
"is_on_rcn": false,
"requires_subscription": "enabled",
"subscription_expires_at": "2024-09-19T13:32:10Z",
"grace_period_ends_at": "2024-10-26T13:32:10Z",
"subscription_is_expired": false,
"subscription_is_on_grace_period": false,
"subscription_is_delinquent": false,
"inventory_policy": "managed",
"status": "active"
},
"invoice_number": "RC123456"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.
Query Parameters
Shipment status
1: shipment is picked up | 0: shipment is not picked up
Search by tracking or purchase order number
Order IDs. Multiple values may be separated by commas.
Past date till current (Unix epoch format)
Connection ID. Multiple values may be separated by commas.
Sorting preference
Page number within the paginated result set
Number of records per page
Response
Total number of records
600
Order ID
677
Shipment ID
767
Batch number of shipment
-2147483648 <= x <= 2147483647
6
Label reference
30
"Sample label 123"
Time of shipment creation (UTC format)
"2021-09-10T15:24:56Z"
Customer order number
1
"765637"
Retailer order number
1
"66367"
Purchase order number
1
"PO-576"
Name of shipping method
1 - 64
"White Glove Bronze"
Code of shipping method
1 - 64
"cory_white_glove"
ID of shipping method
5
Type of shipping method
small_parcel
, ltl
"ltl (less than truck load)"
Name of shipping method
1 - 32
"LTL"
Description of shipping method
1 - 128
"Less than truckload (LTL)"
ID of shipping method
5
Type of shipping method
small_parcel
, ltl
"ltl"
Nickname of shipping account
1 - 64
"Hobie FedEx"
Shipping account ID
3
Owner of shipping account
"Sample Owner"
true: Is a first-party billed shipment | false Is not a first-party billed shipment bill
true
Tracking number for shipment
128
"1Z9999999999999988"
URL for tracking shipment
"https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988"
Time of order pickup
"2022-08-10T15:24:56Z"
Time of order delivery
"2022-09-10T15:24:56Z"
Tracking status
1 - 32
"Delivered"
Status details
1 - 64
"Out for delivery"
Tracking ID
78895456
Time of tracking (UTC format)
"10-10-2022"
Country of delivery
8
"USA"
State of delivery
8
"New York"
City of delivery
32
"New York"
Postal code for delivery
16
"123R32"
Status of shipment
1
"Shipped"
true: Shipment is acknowledged | false: Shipment is not acknowledged
true
true: Shipment has commercial invoice | Shipment does not have commercial invoice
true
Time of cancellation (UTC format)
null
Name of the primary contact?
1 - 64
"Demo Brand, Inc"
Line 1 of the address
1 - 128
"1332 Hermosa Ave"
City name
1 - 64
"Hermosa Beach"
State name
1 - 32
"CA"
Postal code
1 - 32
"90254"
Country name
1 - 128
"US"
Address ID
10
Type of address
residential
, commercial
"residential"
Name of the alternative contact?
64
null
Line 2 of the address
128
null
Primary contact number
32
"3105551212"
Alternate contact number
32
"3105551213"
Fax number
32
null
Contact email address
128
null
Federal tax ID
32
null
Name of the primary contact?
1 - 64
"Demo Brand, Inc"
Line 1 of the address
1 - 128
"1332 Hermosa Ave"
City name
1 - 64
"Hermosa Beach"
State name
1 - 32
"CA"
Postal code
1 - 32
"90254"
Country name
1 - 128
"US"
Address ID
10
Type of address
residential
, commercial
"residential"
Name of the alternative contact?
64
null
Line 2 of the address
128
null
Primary contact number
32
"3105551212"
Alternate contact number
32
"3105551213"
Fax number
32
null
Contact email address
128
null
Federal tax ID
32
null
Name of the primary contact?
1 - 64
"Demo Brand, Inc"
Line 1 of the address
1 - 128
"1332 Hermosa Ave"
City name
1 - 64
"Hermosa Beach"
State name
1 - 32
"CA"
Postal code
1 - 32
"90254"
Country name
1 - 128
"US"
Address ID
10
Type of address
residential
, commercial
"residential"
Name of the alternative contact?
64
null
Line 2 of the address
128
null
Primary contact number
32
"3105551212"
Alternate contact number
32
"3105551213"
Fax number
32
null
Contact email address
128
null
Federal tax ID
32
null
Shipment weight
10
Shipment width
1
Shipment length
1
Shipment height
1
Shipment girth
Shipment volume
4
true: Shipment has valid packing slip | false: Shipment does not valid packing slip
true
true: Shipment has valid shipping label | false: Shipment does not valid valid shipping label
true
Identifier of the shipping provider
64
"shp_3a61e10243da49ab92f0e3861d5d256b"
Time of acknowledgement (UTC format)
"2022-08-10T15:24:56Z"
Time of shipment closure (UTC format)
null
Time of delivery (UTC format)
"2022-09-10T15:24:56Z"
Time of shipping (UTC format)
"2022-09-10T15:24:56Z"
Time of shipment update (UTC format)
"2022-09-10T15:25:56Z"
Time of shipment creation (UTC format)
"2022-09-10T15:24:56Z"
Shipment line ID
1001
Order line number
"1001"
Order quantity
-2147483648 <= x <= 2147483647
1
Internal only
-2147483648 <= x <= 2147483647
1
Freight class
50
, 55
, 60
, 65
, 70
, 77.5
, 85
, 92.5
, 100
, 110
, 125
, 150
, 175
, 200
, 250
, 300
, 400
, 500
50
Time of last update
"2022-09-10T15:24:56Z"
Variant ID
249
Variant name
200
"Var45"
Vendor code. Same as vendor name in lower case and hyphenated
1 - 64
"marla-store"
Vendor ID
456
Vendor name
1 - 64
"Marla Store"
Stock Keeping Unit (SKU), unique identifier of a product
128
"123-DEF12345"
Brand identifier
1
"HATR"
Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your drop-shipping store
64
555555555202
Retailer ID
5642
Stock Keeping Unit (SKU), unique identifier of a product
256
"SKU976"
Retailer name
256
"Retailer Sample"
Signature criteria
required
, not_required
, adult
null
Vendor code, which is vendor name in lower case and underscore
1 - 64
"demo-brand"
Vendor (brand) ID
500
Vendor name
1 - 64
"Marla Cielo"
Time when vendor joined Dropship (UTC format)
"2022-09-10T15:24:56Z"
URL of the brand logo
1
"https://images.revcascade.com/retailers/defaults/logo-lg.png"
URL of the cover image
1
"https://images.revcascade.com/retailers/defaults/cover.png"
URL of the profile image
1
"https://images.revcascade.com/retailers/defaults/profile-tile.png"
URL of brand website
100
null
true: Vendor is onboarded | false: Vendor is not onboarded
false
true: is on Dropship network | false: not on Dropship network
false
Represents whether subscription is required
disabled
, enabled
, upcoming
"enabled"
Subscription expiry Time (UTC format)
"2024-09-19T13:32:10Z"
Time of grace period expiration (UTC format)
"2024-10-26T13:32:10Z"
true: subscription is expired | false: subscription is active
false
true: subscription is on grace period | false: subscription is not on grace period
false
true: subscription is overdue | false: subscription is paid
false
Inventory policy
unmanaged
, managed
, use_variant_policy
"managed"
Vendor status
active
, pending
, inactive
"active"
Invoice number
"RC123456"
Next page (applicable in a paginated response)
"https://api.example.org/demo/{retailer_id}/?page=5"
Previous page (applicable in a paginated response)
"https://api.example.org/demo/{retailer_id}/?page=3"
Was this page helpful?
curl --request GET \
--url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/ \
--header 'Authorization: Bearer <token>'
{
"count": 600,
"next": "https://api.example.org/demo/{retailer_id}/?page=5",
"previous": "https://api.example.org/demo/{retailer_id}/?page=3",
"results": [
{
"id": 767,
"order_id": 677,
"batch_number": 6,
"label_reference": "Sample label 123",
"ordered_at": "2021-09-10T15:24:56Z",
"customer_order_number": "765637",
"retailer_order_number": "66367",
"purchase_order_number": "PO-576",
"shipping_method": {
"id": 5,
"name": "White Glove Bronze",
"code": "cory_white_glove",
"type": "ltl (less than truck load)",
"carrier": {
"id": 229,
"name": "Cory Companies",
"code": "CJCD"
},
"generic_shipping_method": {
"id": 5,
"name": "LTL",
"description": "Less than truckload (LTL)",
"type": "ltl"
}
},
"shipping_account": {
"id": 3,
"nickname": "Hobie FedEx",
"owner": "Sample Owner",
"carrier": {
"id": 229,
"name": "Cory Companies",
"code": "CJCD"
},
"is_first_party_bill": true
},
"tracking_number": "1Z9999999999999988",
"tracking_url": "https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988",
"tracking": {
"picked_up_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z",
"tracking_details": [
{
"id": 78895456,
"time": "10-10-2022",
"status": "Delivered",
"status_detail": "Out for delivery",
"country": "USA",
"state": "New York",
"city": "New York",
"postal_code": "123R32"
}
]
},
"status": "Shipped",
"is_acknowledged": true,
"has_commercial_invoice": true,
"canceled_at": null,
"sold_to": {
"id": 10,
"type": "residential",
"name1": "Demo Brand, Inc",
"name2": null,
"street1": "1332 Hermosa Ave",
"street2": null,
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US",
"phone1": "3105551212",
"phone2": "3105551213",
"fax": null,
"email": null,
"federal_tax_id": null
},
"ship_to": {
"id": 10,
"type": "residential",
"name1": "Demo Brand, Inc",
"name2": null,
"street1": "1332 Hermosa Ave",
"street2": null,
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US",
"phone1": "3105551212",
"phone2": "3105551213",
"fax": null,
"email": null,
"federal_tax_id": null
},
"ship_from": {
"id": 10,
"type": "residential",
"name1": "Demo Brand, Inc",
"name2": null,
"street1": "1332 Hermosa Ave",
"street2": null,
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US",
"phone1": "3105551212",
"phone2": "3105551213",
"fax": null,
"email": null,
"federal_tax_id": null
},
"ship_weight": 10,
"ship_width": 1,
"ship_length": 1,
"ship_height": 1,
"ship_girth": "<string>",
"ship_volume": 4,
"valid_packing_slip": true,
"valid_shipping_label": true,
"shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
"error_logs": {
"id": 677,
"message": "Sample errors to fix",
"count": 12,
"created_at": "2022-08-10T15:24:56Z"
},
"acknowledged_at": "2022-08-10T15:24:56Z",
"closed_at": null,
"delivered_at": "2022-09-10T15:24:56Z",
"shipped_at": "2022-09-10T15:24:56Z",
"updated_at": "2022-09-10T15:25:56Z",
"created_at": "2022-09-10T15:24:56Z",
"shipment_lines": [
{
"id": 1001,
"order_line_number": "1001",
"quantity": 1,
"part": 1,
"freight_class": 50,
"updated_at": "2022-09-10T15:24:56Z",
"variant": {
"id": 249,
"name": "Var45",
"brand": {
"id": 456,
"code": "marla-store",
"name": "Marla Store"
},
"identifier": "123-DEF12345",
"brand_identifier": "HATR",
"upc": 555555555202,
"retailer_identifiers": [
{
"id": 5642,
"retailer": {
"id": 500,
"name": "Demo Retailer",
"code": "demo-retailer",
"logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
"cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
"profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
"joined_at": "2021-08-03T17:24:12Z",
"is_rcn_retailer": false,
"is_onboarded": false,
"platform": "fabric",
"requires_subscription": "disabled",
"brand_permit_creation_allowed": false,
"website": "https://demoabc.com",
"status": "active"
},
"identifier": "SKU976",
"name": "Retailer Sample"
}
]
}
}
],
"signature": null,
"brand": {
"id": 500,
"name": "Marla Cielo",
"code": "demo-brand",
"joined_at": "2022-09-10T15:24:56Z",
"logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png",
"cover_url": "https://images.revcascade.com/retailers/defaults/cover.png",
"profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png",
"website": null,
"is_onboarded": false,
"is_on_rcn": false,
"requires_subscription": "enabled",
"subscription_expires_at": "2024-09-19T13:32:10Z",
"grace_period_ends_at": "2024-10-26T13:32:10Z",
"subscription_is_expired": false,
"subscription_is_on_grace_period": false,
"subscription_is_delinquent": false,
"inventory_policy": "managed",
"status": "active"
},
"invoice_number": "RC123456"
}
]
}