List fulfillments or shipments from vendors

GET

retailers

{retailer_id}

shipments

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

Authorization

string

header

required

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

Path Parameters

retailer_id

number

required

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

status

string

Shipment status

is_acknowledged

number

1: shipment is picked up | 0: shipment is not picked up

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

Example:

600

results

object[]

required

results.order_id

integer

required

Order ID

Example:

677

results.id

integer

Shipment ID

Example:

767

results.batch_number

integer | null

Batch number of shipment

Required range: -2147483648 <= x <= 2147483647

Example:

6

results.label_reference

string | null

Label reference

Maximum length: 30

Example:

"Sample label 123"

results.ordered_at

string

Time of shipment creation (UTC format)

Example:

"2021-09-10T15:24:56Z"

results.customer_order_number

string

Customer order number

Minimum length: 1

Example:

"765637"

results.retailer_order_number

string

Retailer order number

Minimum length: 1

Example:

"66367"

results.purchase_order_number

string

Purchase order number

Minimum length: 1

Example:

"PO-576"

results.shipping_method

object

results.shipping_account

object

results.tracking_number

string | null

Tracking number for shipment

Maximum length: 128

Example:

"1Z9999999999999988"

results.tracking_url

string

URL for tracking shipment

Example:

"https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988"

results.tracking

object

results.status

string

Status of shipment

Minimum length: 1

Example:

"Shipped"

results.is_acknowledged

boolean

true: Shipment is acknowledged | false: Shipment is not acknowledged

Example:

true

results.has_commercial_invoice

boolean

true: Shipment has commercial invoice | Shipment does not have commercial invoice

Example:

true

results.canceled_at

string | null

Time of cancellation (UTC format)

Example:

null

results.sold_to

object

results.ship_to

object

results.ship_from

object

results.ship_weight

number | null

Shipment weight

Example:

10

results.ship_width

number | null

Shipment width

Example:

1

results.ship_length

number | null

Shipment length

Example:

1

results.ship_height

number | null

Shipment height

Example:

1

results.ship_girth

string

Shipment girth

results.ship_volume

string

Shipment volume

Example:

4

results.valid_packing_slip

boolean

true: Shipment has valid packing slip | false: Shipment does not valid packing slip

Example:

true

results.valid_shipping_label

boolean

true: Shipment has valid shipping label | false: Shipment does not valid valid shipping label

Example:

true

results.shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum length: 64

Example:

"shp_3a61e10243da49ab92f0e3861d5d256b"

results.error_logs

object

results.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

"2022-08-10T15:24:56Z"

results.closed_at

string | null

Time of shipment closure (UTC format)

Example:

null

results.delivered_at

string | null

Time of delivery (UTC format)

Example:

"2022-09-10T15:24:56Z"

results.shipped_at

string | null

Time of shipping (UTC format)

Example:

"2022-09-10T15:24:56Z"

results.updated_at

string

Time of shipment update (UTC format)

Example:

"2022-09-10T15:25:56Z"

results.created_at

string

Time of shipment creation (UTC format)

Example:

"2022-09-10T15:24:56Z"

results.shipment_lines

object[]

results.shipment_lines.id

integer

Shipment line ID

Example:

1001

results.shipment_lines.order_line_number

string

Order line number

Example:

"1001"

results.shipment_lines.quantity

integer

Order quantity

Required range: -2147483648 <= x <= 2147483647

Example:

1

results.shipment_lines.part

integer

Internal only

Required range: -2147483648 <= x <= 2147483647

Example:

1

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

Example:

50

results.shipment_lines.updated_at

string

Time of last update

Example:

"2022-09-10T15:24:56Z"

results.shipment_lines.variant

object

results.signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

Example:

null

results.brand

object

results.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

results.brand.id

integer

Vendor (brand) ID

Example:

500

results.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

results.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

"2022-09-10T15:24:56Z"

results.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

"https://images.revcascade.com/retailers/defaults/logo-lg.png"

results.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

"https://images.revcascade.com/retailers/defaults/cover.png"

results.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

"https://images.revcascade.com/retailers/defaults/profile-tile.png"

results.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

results.brand.is_onboarded

boolean

true: Vendor is onboarded | false: Vendor is not onboarded

Example:

false

results.brand.is_on_rcn

boolean

true: is on Dropship network | false: not on Dropship network

Example:

false

results.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

results.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

"2024-09-19T13:32:10Z"

results.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

"2024-10-26T13:32:10Z"

results.brand.subscription_is_expired

boolean

true: subscription is expired | false: subscription is active

Example:

false

results.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period | false: subscription is not on grace period

Example:

false

results.brand.subscription_is_delinquent

boolean

true: subscription is overdue | false: subscription is paid

Example:

false

results.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

results.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

results.invoice_number

string

Invoice number

Example:

"RC123456"

string | null

Next page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=5"

string | null

Previous page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=3"

Acknowledge return Get a single shipment

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"
    }
  ]
}

Merchants

Merchant API Endpoints

Suppliers

List fulfillments or shipments from vendors

Authorizations

Path Parameters

Query Parameters

Response