Merchants
- Overview
- Plan Your Dropship Implementation
- Dropship Integrations
- Merchant Best Practices
- 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
Shipments
Acknowledge shipment receipt
After successfully processing a shipment, the shipment should be acknowledged so that it does not appear in subsequent requests to /shipments/?is_acknowledged=0
.
PUT
/
v1
/
retailers
/
{retailer_id}
/
shipments
/
{id}
/
acknowledge
curl --request PUT \
--url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/{id}/acknowledge/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"order_id": 677,
"batch_number": 6,
"label_reference": "Sample label 123",
"shipping_method": {
"name": "White Glove Bronze",
"code": "cory_white_glove",
"type": "ltl (less than truck load)",
"carrier": {
"name": "Cory Companies",
"code": "CJCD"
},
"generic_shipping_method": {
"name": "LTL",
"description": "Less than truckload (LTL)",
"type": "ltl"
}
},
"shipping_account": {
"nickname": "Hobie FedEx",
"carrier": {
"name": "Cory Companies",
"code": "CJCD"
},
"is_first_party_bill": true
},
"tracking_number": "1Z9999999999999988",
"tracking": {
"picked_up_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z"
},
"has_commercial_invoice": true,
"canceled_at": null,
"sold_to": {
"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": {
"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": {
"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,
"shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
"error_logs": {
"message": "Sample errors to fix"
},
"acknowledged_at": "2022-08-10T15:24:56Z",
"closed_at": null,
"delivered_at": "2022-09-10T15:24:56Z",
"shipped_at": "2022-09-10T15:24:56Z",
"signature": null,
"brand": {
"name": "Marla Cielo",
"code": "demo-brand",
"website": null,
"is_on_rcn": false,
"requires_subscription": "enabled",
"subscription_expires_at": "2024-09-19T13:32:10Z",
"grace_period_ends_at": "2024-10-26T13:32:10Z",
"inventory_policy": "managed",
"status": "active"
}
}'
{
"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.
The unique shipment ID. This ID is automatically generated when a new shipment is created.
Body
application/json
Response
200 - application/json
OK
The response is of type object
.
Was this page helpful?
curl --request PUT \
--url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/{id}/acknowledge/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"order_id": 677,
"batch_number": 6,
"label_reference": "Sample label 123",
"shipping_method": {
"name": "White Glove Bronze",
"code": "cory_white_glove",
"type": "ltl (less than truck load)",
"carrier": {
"name": "Cory Companies",
"code": "CJCD"
},
"generic_shipping_method": {
"name": "LTL",
"description": "Less than truckload (LTL)",
"type": "ltl"
}
},
"shipping_account": {
"nickname": "Hobie FedEx",
"carrier": {
"name": "Cory Companies",
"code": "CJCD"
},
"is_first_party_bill": true
},
"tracking_number": "1Z9999999999999988",
"tracking": {
"picked_up_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z"
},
"has_commercial_invoice": true,
"canceled_at": null,
"sold_to": {
"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": {
"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": {
"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,
"shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
"error_logs": {
"message": "Sample errors to fix"
},
"acknowledged_at": "2022-08-10T15:24:56Z",
"closed_at": null,
"delivered_at": "2022-09-10T15:24:56Z",
"shipped_at": "2022-09-10T15:24:56Z",
"signature": null,
"brand": {
"name": "Marla Cielo",
"code": "demo-brand",
"website": null,
"is_on_rcn": false,
"requires_subscription": "enabled",
"subscription_expires_at": "2024-09-19T13:32:10Z",
"grace_period_ends_at": "2024-10-26T13:32:10Z",
"inventory_policy": "managed",
"status": "active"
}
}'
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.