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_pk}/shipments/{id}/acknowledge

Try it

Acknowledge shipment receipt

cURL

curl --request PUT \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/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": {
    "name1": "Demo Brand, Inc",
    "street1": "1332 Hermosa Ave",
    "city": "Hermosa Beach",
    "province": "CA",
    "postal_code": "90254",
    "country": "US",
    "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",
    "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",
    "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,
  "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": {
    "code": "demo-brand",
    "name": "Marla Cielo",
    "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"
  }
}
'

200

{
  "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": [
      {
        "Time": "10-10-2022",
        "status": "Delivered",
        "status_detail": "Out for delivery",
        "id": 78895456,
        "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"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · integer · required

Shipment ID

retailer_pk · number · required

Retailer ID

Body

application/json

order_id · integer · required

Order ID

Example:

677

batch_number · integer | null

Batch number of shipment

Required range: -2147483648 <= x <= 2147483647

Example:

6

label_reference · string | null

Label reference

Maximum string length: 30

Example:

"Sample label 123"

shipping_method · object

Show child attributes

shipping_method. name · string · required

Name of shipping method

Required string length: 1 - 64

Example:

"White Glove Bronze"

shipping_method. code · string · required

Code of shipping method

Required string length: 1 - 64

Example:

"cory_white_glove"

shipping_method. type · enum<string>

Type of shipping method

Available options: small_parcel, ltl

Example:

"ltl (less than truck load)"

shipping_method. carrier · object

Show child attributes

shipping_method.carrier. name · string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

shipping_method.carrier. code · string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

shipping_method. generic_shipping_method · object

Show child attributes

shipping_method.generic_shipping_method. name · string · required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

shipping_method.generic_shipping_method. description · string · required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

shipping_method.generic_shipping_method. type · enum<string>

Type of shipping method

Available options: small_parcel, ltl

Example:

"ltl"

shipping_account · object

Show child attributes

shipping_account. nickname · string · required

Nickname of shipping account

Required string length: 1 - 64

Example:

"Hobie FedEx"

shipping_account. carrier · object

Show child attributes

shipping_account.carrier. name · string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

shipping_account.carrier. code · string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

shipping_account. is_first_party_bill · boolean

true: is first party billed shipment
false Is not first party bill

Example:

true

tracking_number · string | null

Tracking number for shipment

Maximum string length: 128

Example:

"1Z9999999999999988"

tracking · object

Show child attributes

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

Time of order pickup

Example:

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

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

Time of order delivery

Example:

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

has_commercial_invoice · boolean

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

Example:

true

canceled_at · string<date-time> | null

Time of cancellation (UTC format)

Example:

null

sold_to · object

Show child attributes

sold_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

sold_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

sold_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

sold_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

sold_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

sold_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

sold_to. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

sold_to. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

sold_to. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

sold_to. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

sold_to. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

sold_to. fax · string | null

Fax number

Maximum string length: 32

Example:

null

sold_to. email · string | null

Contact email address

Maximum string length: 128

Example:

null

sold_to. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_to · object

Show child attributes

ship_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

ship_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

ship_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

ship_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

ship_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

ship_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

ship_to. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

ship_to. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

ship_to. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

ship_to. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

ship_to. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

ship_to. fax · string | null

Fax number

Maximum string length: 32

Example:

null

ship_to. email · string | null

Contact email address

Maximum string length: 128

Example:

null

ship_to. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_from · object

Show child attributes

ship_from. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

ship_from. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

ship_from. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

ship_from. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

ship_from. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

ship_from. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

ship_from. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

ship_from. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

ship_from. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

ship_from. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

ship_from. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

ship_from. fax · string | null

Fax number

Maximum string length: 32

Example:

null

ship_from. email · string | null

Contact email address

Maximum string length: 128

Example:

null

ship_from. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_weight · number | null

Shipment weight

Example:

10

ship_width · number | null

Shipment width

Example:

1

ship_length · number | null

Shipment length

Example:

1

ship_height · number | null

Shipment height

Example:

1

shipping_provider_identifier · string | null

Identifier of the shipping provider

Maximum string length: 64

Example:

"shp_3a61e10243da49ab92f0e3861d5d256b"

error_logs · object

Show child attributes

error_logs. message · string | null

Message in error log

Example:

"Sample errors to fix"

acknowledged_at · string<date-time> | null

Time of acknowledgement (UTC format)

Example:

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

closed_at · string<date-time> | null

Time of shipment closure (UTC format)

Example:

null

delivered_at · string<date-time> | null

Time of delivery (UTC format)

Example:

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

shipped_at · string<date-time> | null

Time of shipping (UTC format)

Example:

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

signature · enum<string> | null

Signature criteria

Available options: required, not_required, adult

Example:

null

brand · object

Show child attributes

brand. code · string<slug> · required

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

Required string length: 1 - 64

Example:

"demo-brand"

brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

brand. website · string<uri> | null

URL of brand website

Maximum string length: 100

Example:

null

brand. is_on_rcn · boolean

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

Example:

false

brand. requires_subscription · enum<string>

Represents whether subscription is required

Available options: disabled, enabled, upcoming

Example:

"enabled"

brand. subscription_expires_at · string<date-time> | null

Subscription expiry Time (UTC format)

Example:

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

brand. grace_period_ends_at · string<date-time> | null

Time of grace period expiration (UTC format)

Example:

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

brand. inventory_policy · enum<string>

Inventory policy

Available options: unmanaged, managed, use_variant_policy

Example:

"managed"

brand. status · enum<string>

Vendor status

Available options: active, pending, inactive

Example:

"active"

Response

200

application/json

OK

order_id · integer · required

Order ID

Example:

677

id · integer

Shipment ID

Example:

767

batch_number · integer | null

Batch number of shipment

Required range: -2147483648 <= x <= 2147483647

Example:

6

label_reference · string | null

Label reference

Maximum string length: 30

Example:

"Sample label 123"

ordered_at · string<date-time>

Time of shipment creation (UTC format)

Example:

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

customer_order_number · string

Customer order number

Minimum string length: 1

Example:

"765637"

retailer_order_number · string

Retailer order number

Minimum string length: 1

Example:

"66367"

purchase_order_number · string

Purchase order number

Minimum string length: 1

Example:

"PO-576"

shipping_method · object

Show child attributes

shipping_method. name · string · required

Name of shipping method

Required string length: 1 - 64

Example:

"White Glove Bronze"

shipping_method. code · string · required

Code of shipping method

Required string length: 1 - 64

Example:

"cory_white_glove"

shipping_method. id · integer

ID of shipping method

Example:

5

shipping_method. type · enum<string>

Type of shipping method

Available options: small_parcel, ltl

Example:

"ltl (less than truck load)"

shipping_method. carrier · object

Show child attributes

shipping_method.carrier. id · integer

Carrier ID

Example:

229

shipping_method.carrier. name · string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

shipping_method.carrier. code · string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

shipping_method. generic_shipping_method · object

Show child attributes

shipping_method.generic_shipping_method. name · string · required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

shipping_method.generic_shipping_method. description · string · required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

shipping_method.generic_shipping_method. id · integer

ID of shipping method

Example:

5

shipping_method.generic_shipping_method. type · enum<string>

Type of shipping method

Available options: small_parcel, ltl

Example:

"ltl"

shipping_account · object

Show child attributes

shipping_account. nickname · string · required

Nickname of shipping account

Required string length: 1 - 64

Example:

"Hobie FedEx"

shipping_account. id · integer

Shipping account ID

Example:

3

shipping_account. owner · string

Owner of shipping account

Example:

"Sample Owner"

shipping_account. carrier · object

Show child attributes

shipping_account.carrier. id · integer

Carrier ID

Example:

229

shipping_account.carrier. name · string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

shipping_account.carrier. code · string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

shipping_account. is_first_party_bill · boolean

true: is first party billed shipment
false Is not first party bill

Example:

true

tracking_number · string | null

Tracking number for shipment

Maximum string length: 128

Example:

"1Z9999999999999988"

tracking_url · string

URL for tracking shipment

Example:

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

tracking · object

Show child attributes

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

Time of order pickup

Example:

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

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

Time of order delivery

Example:

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

tracking. tracking_details · object[]

Show child attributes

tracking.tracking_details. Time · string<date-time> · required

Time of tracking (UTC format)

Example:

"10-10-2022"

tracking.tracking_details. status · string · required

Tracking status

Required string length: 1 - 32

Example:

"Delivered"

tracking.tracking_details. status_detail · string · required

Status details

Required string length: 1 - 64

Example:

"Out for delivery"

tracking.tracking_details. id · integer

Tracking ID

Example:

78895456

tracking.tracking_details. country · string | null

Country of delivery

Maximum string length: 8

Example:

"USA"

tracking.tracking_details. state · string | null

State of delivery

Maximum string length: 8

Example:

"New york"

tracking.tracking_details. city · string | null

City of delivery

Maximum string length: 32

Example:

"New york"

tracking.tracking_details. postal_code · string | null

Postal code for delivery

Maximum string length: 16

Example:

"123R32"

status · string

Status of shipment

Minimum string length: 1

Example:

"Shipped"

is_acknowledged · boolean

true: Shipment is acknowledged
false: Shipment is not acknowledged

Example:

true

has_commercial_invoice · boolean

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

Example:

true

canceled_at · string<date-time> | null

Time of cancellation (UTC format)

Example:

null

sold_to · object

Show child attributes

sold_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

sold_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

sold_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

sold_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

sold_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

sold_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

sold_to. id · integer

Address ID

Example:

10

sold_to. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

sold_to. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

sold_to. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

sold_to. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

sold_to. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

sold_to. fax · string | null

Fax number

Maximum string length: 32

Example:

null

sold_to. email · string | null

Contact email address

Maximum string length: 128

Example:

null

sold_to. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_to · object

Show child attributes

ship_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

ship_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

ship_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

ship_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

ship_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

ship_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

ship_to. id · integer

Address ID

Example:

10

ship_to. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

ship_to. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

ship_to. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

ship_to. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

ship_to. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

ship_to. fax · string | null

Fax number

Maximum string length: 32

Example:

null

ship_to. email · string | null

Contact email address

Maximum string length: 128

Example:

null

ship_to. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_from · object

Show child attributes

ship_from. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

ship_from. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

ship_from. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

ship_from. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

ship_from. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

ship_from. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

ship_from. id · integer

Address ID

Example:

10

ship_from. type · enum<string> | null

Type of address

Available options: residential, commercial

Example:

"residential"

ship_from. name2 · string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

ship_from. street2 · string | null

Line 2 of the address

Maximum string length: 128

Example:

null

ship_from. phone1 · string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

ship_from. phone2 · string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

ship_from. fax · string | null

Fax number

Maximum string length: 32

Example:

null

ship_from. email · string | null

Contact email address

Maximum string length: 128

Example:

null

ship_from. federal_tax_id · string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_weight · number | null

Shipment weight

Example:

10

ship_width · number | null

Shipment width

Example:

1

ship_length · number | null

Shipment length

Example:

1

ship_height · number | null

Shipment height

Example:

1

ship_girth · string

Shipment girth

ship_volume · string

Shipment volume

Example:

4

valid_packing_slip · boolean

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

Example:

true

valid_shipping_label · boolean

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

Example:

true

shipping_provider_identifier · string | null

Identifier of the shipping provider

Maximum string length: 64

Example:

"shp_3a61e10243da49ab92f0e3861d5d256b"

error_logs · object

Show child attributes

error_logs. id · integer

Error log ID

Example:

677

error_logs. message · string | null

Message in error log

Example:

"Sample errors to fix"

error_logs. count · integer

Count of error log

Example:

12

error_logs. created_at · string<date-time>

Time of error log creation

Example:

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

acknowledged_at · string<date-time> | null

Time of acknowledgement (UTC format)

Example:

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

closed_at · string<date-time> | null

Time of shipment closure (UTC format)

Example:

null

delivered_at · string<date-time> | null

Time of delivery (UTC format)

Example:

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

shipped_at · string<date-time> | null

Time of shipping (UTC format)

Example:

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

updated_at · string<date-time>

Time of shipment update (UTC format)

Example:

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

created_at · string<date-time>

Time of shipment creation (UTC format)

Example:

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

shipment_lines · object[]

Show child attributes

shipment_lines. id · integer

Shipment line ID

Example:

1001

shipment_lines. order_line_number · string

Order line number

Example:

"1001"

shipment_lines. quantity · integer

Order quantity

Required range: -2147483648 <= x <= 2147483647

Example:

1

shipment_lines. part · integer

Internal only

Required range: -2147483648 <= x <= 2147483647

Example:

1

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

shipment_lines. updated_at · string<date-time>

Time of last update

Example:

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

shipment_lines. variant · object

Show child attributes

shipment_lines.variant. id · integer

Variant ID

Example:

249

shipment_lines.variant. name · string | null

Variant name

Maximum string length: 200

Example:

"Var45"

shipment_lines.variant. brand · object

Show child attributes

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"

shipment_lines.variant.brand. id · integer

Vendor ID

Example:

456

shipment_lines.variant.brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Store"

shipment_lines.variant. identifier · string | null

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

Maximum string length: 128

Example:

"123-DEF12345"

shipment_lines.variant. brand_identifier · string

Brand identifier

Minimum string length: 1

Example:

"HATR"

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

shipment_lines.variant. retailer_identifiers · object[]

Show child attributes

shipment_lines.variant.retailer_identifiers. id · integer

Retailer ID

Example:

5642

shipment_lines.variant.retailer_identifiers. retailer · object

Show child attributes

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

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

shipment_lines.variant.retailer_identifiers.retailer. id · integer

Retailer ID

Example:

500

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"

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"

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"

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

Time of retailer joining Dropship (UTC format)

Example:

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

shipment_lines.variant.retailer_identifiers.retailer. is_rcn_retailer · boolean

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

Example:

false

shipment_lines.variant.retailer_identifiers.retailer. is_onboarded · boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

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

Platform on which retailer is onboarded

Available options: fabric

Example:

"fabric"

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"

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

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

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

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

Retailer status

Available options: active, setup, ghost

Example:

"active"

shipment_lines.variant.retailer_identifiers. identifier · string | null

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

Maximum string length: 256

Example:

"SKU976"

shipment_lines.variant.retailer_identifiers. name · string | null

Retailer name

Maximum string length: 256

Example:

"Retailer Sample"

signature · enum<string> | null

Signature criteria

Available options: required, not_required, adult

Example:

null

brand · object

Show child attributes

brand. code · string<slug> · required

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

Required string length: 1 - 64

Example:

"demo-brand"

brand. id · integer

Vendor (brand) ID

Example:

500

brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

brand. joined_at · string<date-time>

Time when vendor joined Dropship (UTC format)

Example:

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

brand. logo_url · string<uri>

URL of the brand logo

Minimum string length: 1

Example:

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

brand. cover_url · string<uri>

URL of the cover image

Minimum string length: 1

Example:

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

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"

brand. website · string<uri> | null

URL of brand website

Maximum string length: 100

Example:

null

brand. is_onboarded · boolean

true: Vendor is onboarded
false: Vendor is not onboarded

Example:

false

brand. is_on_rcn · boolean

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

Example:

false

brand. requires_subscription · enum<string>

Represents whether subscription is required

Available options: disabled, enabled, upcoming

Example:

"enabled"

brand. subscription_expires_at · string<date-time> | null

Subscription expiry Time (UTC format)

Example:

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

brand. grace_period_ends_at · string<date-time> | null

Time of grace period expiration (UTC format)

Example:

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

brand. subscription_is_expired · boolean

true: subscription is expired
false: subscription is active

Example:

false

brand. subscription_is_on_grace_period · boolean

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

Example:

false

brand. subscription_is_delinquent · boolean

true: subscription is overdue
false: subscription is paid

Example:

false

brand. inventory_policy · enum<string>

Inventory policy

Available options: unmanaged, managed, use_variant_policy

Example:

"managed"

brand. status · enum<string>

Vendor status

Available options: active, pending, inactive

Example:

"active"

invoice_number · string

Invoice number

Example:

"RC123456"