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.

GET /v1/retailers/{retailer_id}/shipments

Try it

List fulfillments or shipments from vendors

cURL

curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/ \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 600,
  "results": [
    {
      "order_id": 677,
      "id": 767,
      "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": {
        "name": "White Glove Bronze",
        "code": "cory_white_glove",
        "id": 5,
        "type": "ltl (less than truck load)",
        "carrier": {
          "id": 229,
          "name": "Cory Companies",
          "code": "CJCD"
        },
        "generic_shipping_method": {
          "name": "LTL",
          "description": "Less than truckload (LTL)",
          "id": 5,
          "type": "ltl"
        }
      },
      "shipping_account": {
        "nickname": "Hobie FedEx",
        "id": 3,
        "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": [
          {
            "status": "Delivered",
            "status_detail": "Out for delivery",
            "id": 78895456,
            "time": "10-10-2022",
            "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": {
        "name1": "Demo Brand, Inc",
        "street1": "1332 Hermosa Ave",
        "city": "Hermosa Beach",
        "province": "CA",
        "postal_code": "90254",
        "country": "US",
        "id": 10,
        "type": "residential",
        "name2": null,
        "street2": null,
        "phone1": "3105551212",
        "phone2": "3105551213",
        "fax": null,
        "email": null,
        "federal_tax_id": null
      },
      "ship_to": {
        "name1": "Demo Brand, Inc",
        "street1": "1332 Hermosa Ave",
        "city": "Hermosa Beach",
        "province": "CA",
        "postal_code": "90254",
        "country": "US",
        "id": 10,
        "type": "residential",
        "name2": null,
        "street2": null,
        "phone1": "3105551212",
        "phone2": "3105551213",
        "fax": null,
        "email": null,
        "federal_tax_id": null
      },
      "ship_from": {
        "name1": "Demo Brand, Inc",
        "street1": "1332 Hermosa Ave",
        "city": "Hermosa Beach",
        "province": "CA",
        "postal_code": "90254",
        "country": "US",
        "id": 10,
        "type": "residential",
        "name2": null,
        "street2": null,
        "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": {
              "code": "marla-store",
              "id": 456,
              "name": "Marla Store"
            },
            "identifier": "123-DEF12345",
            "brand_identifier": "HATR",
            "upc": 555555555202,
            "retailer_identifiers": [
              {
                "id": 5642,
                "retailer": {
                  "name": "Demo Retailer",
                  "code": "demo-retailer",
                  "id": 500,
                  "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": {
        "code": "demo-brand",
        "id": 500,
        "name": "Marla Cielo",
        "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"
    }
  ],
  "next": "https://api.example.org/demo/{retailer_id}/?page=5",
  "previous": "https://api.example.org/demo/{retailer_id}/?page=3"
}

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

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

OK

count · integer · required

Total number of records

Example:

600

results · object[] · required

Show child attributes

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 string length: 30

Example:

"Sample label 123"

results. ordered_at · string<date-time>

Time of shipment creation (UTC format)

Example:

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

results. customer_order_number · string

Customer order number

Minimum string length: 1

Example:

"765637"

results. retailer_order_number · string

Retailer order number

Minimum string length: 1

Example:

"66367"

results. purchase_order_number · string

Purchase order number

Minimum string length: 1

Example:

"PO-576"

results. shipping_method · object

Show child attributes

results.shipping_method. name · string · required

Name of shipping method

Required string length: 1 - 64

Example:

"White Glove Bronze"

results.shipping_method. code · string · required

Code of shipping method

Required string length: 1 - 64

Example:

"cory_white_glove"

results.shipping_method. id · integer

ID of shipping method

Example:

5

results.shipping_method. type · enum<string>

Type of shipping method

Available options: small_parcel, ltl

Example:

"ltl (less than truck load)"

results.shipping_method. carrier · object

Show child attributes

results.shipping_method.carrier. id · integer

Carrier ID

Example:

229

results.shipping_method.carrier. name · string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

results.shipping_method.carrier. code · string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

results.shipping_method. generic_shipping_method · object

Show child attributes

results.shipping_method.generic_shipping_method. name · string · required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

results.shipping_method.generic_shipping_method. description · string · required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

results.shipping_method.generic_shipping_method. id · integer

ID of shipping method

Example:

5

results.shipping_method.generic_shipping_method. type · enum<string>

Type of shipping method

Available options: small_parcel, ltl

Example:

"ltl"

results. shipping_account · object

Show child attributes

results.shipping_account. nickname · string · required

Nickname of shipping account

Required string length: 1 - 64

Example:

"Hobie FedEx"

results.shipping_account. id · integer

Shipping account ID

Example:

3

results.shipping_account. owner · string

Owner of shipping account

Example:

"Sample Owner"

results.shipping_account. carrier · object

Show child attributes

results.shipping_account.carrier. id · integer

Carrier ID

Example:

229

results.shipping_account.carrier. name · string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

results.shipping_account.carrier. code · string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

results.shipping_account. is_first_party_bill · boolean

true: Is a first-party billed shipment | false Is not a first-party billed shipment bill

Example:

true

results. tracking_number · string | null

Tracking number for shipment

Maximum string 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

Show child attributes

results.tracking. picked_up_at · string<date-time> | null

Time of order pickup

Example:

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

results.tracking. delivered_at · string<date-time> | null

Time of order delivery

Example:

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

results.tracking. tracking_details · object[]

Show child attributes

results.tracking.tracking_details. status · string · required

Tracking status

Required string length: 1 - 32

Example:

"Delivered"

results.tracking.tracking_details. status_detail · string · required

Status details

Required string length: 1 - 64

Example:

"Out for delivery"

results.tracking.tracking_details. id · integer

Tracking ID

Example:

78895456

results.tracking.tracking_details. time · string<date-time>

Time of tracking (UTC format)

Example:

"10-10-2022"

results.tracking.tracking_details. country · string | null

Country of delivery

Maximum string length: 8

Example:

"USA"

results.tracking.tracking_details. state · string | null

State of delivery

Maximum string length: 8

Example:

"New York"

results.tracking.tracking_details. city · string | null

City of delivery

Maximum string length: 32

Example:

"New York"

results.tracking.tracking_details. postal_code · string | null

Postal code for delivery

Maximum string length: 16

Example:

"123R32"

results. status · string

Status of shipment

Minimum string 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<date-time> | null

Time of cancellation (UTC format)

Example:

null

results. sold_to · object

Show child attributes

results.sold_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

results.sold_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

results.sold_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

results.sold_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

results.sold_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

results.sold_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

results.sold_to. id · integer

Address ID

Example:

10

results.sold_to. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

results.sold_to. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

results.sold_to. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

results.sold_to. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

results.sold_to. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

results.sold_to. fax · string | null

Fax number

Maximum string length: 32

Example:

null

results.sold_to. email · string | null

Contact email address

Maximum string length: 128

Example:

null

results.sold_to. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

results. ship_to · object

Show child attributes

results.ship_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

results.ship_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

results.ship_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

results.ship_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

results.ship_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

results.ship_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

results.ship_to. id · integer

Address ID

Example:

10

results.ship_to. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

results.ship_to. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

results.ship_to. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

results.ship_to. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

results.ship_to. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

results.ship_to. fax · string | null

Fax number

Maximum string length: 32

Example:

null

results.ship_to. email · string | null

Contact email address

Maximum string length: 128

Example:

null

results.ship_to. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

results. ship_from · object

Show child attributes

results.ship_from. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

results.ship_from. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

results.ship_from. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

results.ship_from. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

results.ship_from. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

results.ship_from. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

results.ship_from. id · integer

Address ID

Example:

10

results.ship_from. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

results.ship_from. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

results.ship_from. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

results.ship_from. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

results.ship_from. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

results.ship_from. fax · string | null

Fax number

Maximum string length: 32

Example:

null

results.ship_from. email · string | null

Contact email address

Maximum string length: 128

Example:

null

results.ship_from. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

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 string length: 64

Example:

"shp_3a61e10243da49ab92f0e3861d5d256b"

results. error_logs · object

Show child attributes

results.error_logs. id · integer

Error log ID

Example:

677

results.error_logs. message · string | null

Message in error log

Example:

"Sample errors to fix"

results.error_logs. count · integer

Count of error log

Example:

12

results.error_logs. created_at · string<date-time>

Time of error log creation

Example:

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

results. acknowledged_at · string<date-time> | null

Time of acknowledgement (UTC format)

Example:

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

results. closed_at · string<date-time> | null

Time of shipment closure (UTC format)

Example:

null

results. delivered_at · string<date-time> | null

Time of delivery (UTC format)

Example:

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

results. shipped_at · string<date-time> | null

Time of shipping (UTC format)

Example:

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

results. updated_at · string<date-time>

Time of shipment update (UTC format)

Example:

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

results. created_at · string<date-time>

Time of shipment creation (UTC format)

Example:

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

results. shipment_lines · object[]

Show child attributes

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<date-time>

Time of last update

Example:

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

results.shipment_lines. variant · object

Show child attributes

results.shipment_lines.variant. id · integer

Variant ID

Example:

249

results.shipment_lines.variant. name · string | null

Variant name

Maximum string length: 200

Example:

"Var45"

results.shipment_lines.variant. brand · object

Show child attributes

results.shipment_lines.variant.brand. code · string<slug> · required

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

Required string length: 1 - 64

Example:

"marla-store"

results.shipment_lines.variant.brand. id · integer

Vendor ID

Example:

456

results.shipment_lines.variant.brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Store"

results.shipment_lines.variant. identifier · string | null

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

Maximum string length: 128

Example:

"123-DEF12345"

results.shipment_lines.variant. brand_identifier · string

Brand identifier

Minimum string length: 1

Example:

"HATR"

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 string length: 64

Example:

555555555202

results.shipment_lines.variant. retailer_identifiers · object[]

Show child attributes

results.shipment_lines.variant.retailer_identifiers. id · integer

Retailer ID

Example:

5642

results.shipment_lines.variant.retailer_identifiers. retailer · object

Show child attributes

results.shipment_lines.variant.retailer_identifiers.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

results.shipment_lines.variant.retailer_identifiers.retailer. code · string<slug> · required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

Example:

"demo-retailer"

results.shipment_lines.variant.retailer_identifiers.retailer. id · integer

Retailer ID

Example:

500

results.shipment_lines.variant.retailer_identifiers.retailer. logo_url · string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

results.shipment_lines.variant.retailer_identifiers.retailer. cover_url · string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

results.shipment_lines.variant.retailer_identifiers.retailer. profile_tile_url · string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

results.shipment_lines.variant.retailer_identifiers.retailer. joined_at · string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

results.shipment_lines.variant.retailer_identifiers.retailer. is_rcn_retailer · boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

Example:

false

results.shipment_lines.variant.retailer_identifiers.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

results.shipment_lines.variant.retailer_identifiers.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options: fabric

Example:

"fabric"

results.shipment_lines.variant.retailer_identifiers.retailer. requires_subscription · enum<string>

Represent whether retailer requires subscription to use the platform

Available options: disabled, enabled, upcoming

Example:

"disabled"

results.shipment_lines.variant.retailer_identifiers.retailer. brand_permit_creation_allowed · boolean

true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit

Example:

false

results.shipment_lines.variant.retailer_identifiers.retailer. website · string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

results.shipment_lines.variant.retailer_identifiers.retailer. status · enum<string>

Retailer status

Available options: active, setup, ghost

Example:

"active"

results.shipment_lines.variant.retailer_identifiers. identifier · string | null

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

Maximum string length: 256

Example:

"SKU976"

results.shipment_lines.variant.retailer_identifiers. name · string | null

Retailer name

Maximum string length: 256

Example:

"Retailer Sample"

results. signature · enum<string> | null

Signature criteria

Available options: required, not_required, adult

Example:

null

results. brand · object

Show child attributes

results.brand. code · string<slug> · 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<date-time>

Time when vendor joined Dropship (UTC format)

Example:

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

results.brand. logo_url · string<uri>

URL of the brand logo

Minimum string length: 1

Example:

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

results.brand. cover_url · string<uri>

URL of the cover image

Minimum string length: 1

Example:

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

results.brand. profile_tile_url · string<uri>

URL of the profile image

Minimum string length: 1

Example:

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

results.brand. website · string<uri> | null

URL of brand website

Maximum string 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<date-time> | null

Subscription expiry Time (UTC format)

Example:

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

results.brand. grace_period_ends_at · string<date-time> | 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"

next · string<uri> | null

Next page (applicable in a paginated response)

Example:

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

previous · string<uri> | null

Previous page (applicable in a paginated response)

Example:

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