Get single order details

Gets the details of a single order by specifying retailer ID and order ID.

Authorizations

Authorization

string

header

required

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

Path Parameters

id

integer

required

Order ID

retailer_pk

number

required

Retailer ID

Response

200

application/json

Ok

purchase_order_number

string

required

Purchase order number

Minimum length: 1

Example:

"1234-100000"

ordered_at

string

required

Time of order finalization (UTC format)

Example:

"2017-08-01T12:00:00Z"

id

integer

Order ID

Example:

1016

customer_order_number

string | null

Customer order number

Maximum length: 64

Example:

"100000"

retailer_order_number

string

Retailer order number

Minimum length: 1

Example:

"1225466845"

brand_identifier

string | null

Vendor identifier

Maximum length: 64

Example:

"423432322"

retailer

object

Show child attributes

retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

retailer.id

integer

Retailer ID

Example:

500

retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

retailer.is_rcn_retailer

boolean

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

Example:

false

retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

brand

object

Show child attributes

brand.code

string

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

Time when vendor joined Dropship (UTC format)

Example:

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

brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

brand.is_on_rcn

boolean

true: is on Dropship network <br /> 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 | null

Subscription expiry Time (UTC format)

Example:

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

brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> 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"

brands

object[]

Show child attributes

brands.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

brands.id

integer

Vendor (brand) ID

Example:

500

brands.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

brands.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

brands.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

brands.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

brands.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

brands.website

string | null

URL of brand website

Maximum length: 100

Example:

null

brands.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

brands.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

brands.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

brands.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

brands.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

brands.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

brands.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

brands.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

brands.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

brands.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

connection_id

integer

A numeric connection ID

Example:

10

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"

requested_shipping_method_id

integer

ID of the requested shipping method

Example:

768

requested_shipping_method

object

Show child attributes

requested_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

requested_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

requested_shipping_method.id

integer

ID of shipping method

Example:

5

requested_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl"

shipment_count

integer

Shipment count

Example:

1

invoice_count

integer

Invoice count

Example:

1

bill_to

object

Show child attributes

bill_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

bill_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

bill_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

bill_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

bill_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

bill_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

bill_to.id

integer

Address ID

Example:

10

bill_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

bill_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

bill_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

bill_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

bill_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

bill_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

bill_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

bill_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

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

Example:

null

sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

sold_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

sold_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

sold_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

sold_to.federal_tax_id

string | null

Federal tax ID

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

Example:

null

ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

ship_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

ship_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

ship_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

ship_to.federal_tax_id

string | null

Federal tax ID

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

Example:

null

ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

ship_from.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

ship_from.fax

string | null

Fax number

Maximum length: 32

Example:

null

ship_from.email

string | null

Contact email address

Maximum length: 128

Example:

null

ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

return_to

object

Show child attributes

return_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

return_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

return_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

return_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

return_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

return_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

return_to.id

integer

Address ID

Example:

10

return_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

return_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

return_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

return_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

return_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

return_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

return_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

return_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

allow_shipping_label_generation

boolean

true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels

Example:

true

subtotal_charged

string

Subtotal amount excluding shipping

Example:

"25.96"

shipping_charged

string

Shipped charged

Example:

"2.99"

is_gift

boolean

true: Order is a gift <br /> false: Order is not a gift

Example:

false

gift_fee

string | null

Gift fee (if applicable)

Example:

null

is_replacement

boolean

true: order is a replacement <br /> false: order is not a replacement

Example:

false

status

string

Order status

Minimum length: 1

Example:

"open"

currency

object

Show child attributes

currency.id

integer

Currency ID

Example:

1

currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

currency.unit

string

Currency unit

Example:

"USD"

is_acknowledged

boolean

true: Order is acknowledged <br /> false: Order is not acknowledged

Example:

false

acknowledged_at

string | null

Time of order acknowledgement (UTC format)

Example:

"2022-08-01T12:00:00Z"

fulfill_by

string

Time when order will be completely fulfilled (UTC format)

Example:

"2022-12-19T03:59:59Z"

fulfilled_at

string | null

Time of order fulfillment (UTC format)

Example:

null

closed_at

string

Time of complete order fulfillment (UTC format)

Example:

null

received_at

string

Time of when order was received (UTC format)

Example:

null

is_on_hold

boolean

true: Order is on hold <br /> false: Order is not on hold

Example:

false

pickup_on

string | null

Time of when order was picked up (UTC format)

Example:

null

on_hold_at

string | null

Time of when order got placed on hold (UTC format)

Example:

null

on_hold_until

string | null

Date till when the order will be on hold

Example:

null

backordered_until

string | null

Time till when product or order is backordered (UTC format)

Example:

null

backorder_acknowledged_at

string | null

Time of backorder acknowledgement (UTC format)

Example:

null

canceled_at

string | null

Time of order cancellation (UTC format)

Example:

null

updated_at

string

Time of order update (UTC format)

Example:

"2022-08-03T17:45:11Z"

order_lines

object[]

Show child attributes

order_lines.quantity

integer

required

Total products in the order

Example:

2

order_lines.ordered_at

string

required

Time of order finalization (UTC format)

Example:

"2022-08-01T12:00:00Z"

order_lines.id

integer

Order line ID

Example:

10013

order_lines.order_line_number

string

Order line number (auto-incremental number)

Example:

"SampleOL-1"

order_lines.quantity_open

integer

Quantity to be shipped

Example:

2

order_lines.quantity_shipped

integer

Quantity shipped

Example:

0

order_lines.quantity_returned

integer

Quantity returned

Example:

0

order_lines.quantity_canceled

string

Quantity cancelled

Example:

0

order_lines.quantity_invoiced

integer

Quantity invoiced

Example:

0

order_lines.packages_per_quantity

integer

Number of packages per quantity

order_lines.price

string

Discounted price

Example:

"8.99"

order_lines.net_price

string

Net price

Example:

"5.39"

order_lines.subtotal

string

Subtotal amount

Example:

"17.98"

order_lines.estimated_price

string | null

Estimated price

Example:

null

order_lines.shipping_charged

string

Shipping cost

Example:

"0.00"

order_lines.gift_fee

string | null

Gift fee

Example:

null

order_lines.subtotal_charged

string

Subtotal charged

Example:

"17.98"

order_lines.tax_charged

string

Tax charged

Example:

"0.00"

order_lines.total_charge

string

Total charge

Example:

"12"

order_lines.status

string

Order status

Minimum length: 1

Example:

"open"

order_lines.fulfill_by

string

Time all products in the order are expected to be completely fulfilled. Automatically determined based on a combination of item lead time and the connection's SLA.

Example:

"2022-12-19T03:59:59Z"

order_lines.canceled_at

string | null

Time of cancellation (UTC format)

Example:

null

order_lines.backordered_until

string

Time till when product is backordered (UTC format)

Example:

null

order_lines.variant

string

Details of product variant

order_lines.metadata

object[]

Show child attributes

order_lines.metadata.id

integer

Metadata ID

Example:

456

order_lines.metadata.name

string

Metadata name

Minimum length: 1

Example:

"MD143"

order_lines.metadata.value

string | null

Metadata value, depending on the type

Example:

"12"

order_lines.metadata.type

string

Metadata type such as integer, float, etc.

Minimum length: 1

Example:

"string"

order_lines.metadata.created_at

string

Time of metadata creation (UTC format)

Example:

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

cancels

object[]

Show child attributes

cancels.reason_id

integer

required

Reason ID associated with cancellation

Example:

879

cancels.id

integer

Cancellation ID

Example:

456

cancels.retailer

object

Show child attributes

cancels.retailer.code

string

required

Retailer code, which same as retailer name but in lower case and underscore

Required string length: 1 - 32

Example:

"hobie_store"

cancels.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Hobie Store"

cancels.retailer.id

integer

Retailer ID

Example:

510

cancels.brand

object

Show child attributes

cancels.brand.code

string

required

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

Required string length: 1 - 64

Example:

"marla-store"

cancels.brand.id

integer

Vendor ID

Example:

456

cancels.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Store"

cancels.canceled_at

string | null

Time of cancellation (UTC format)

Example:

null

cancels.canceled_by

enum<string> | null

User that initiated cancellation

Available options:

retailer,

brand

Example:

"retailer"

cancels.cancel_lines

object[]

Show child attributes

cancels.cancel_lines.id

integer

Cancel line ID

Example:

7898

cancels.cancel_lines.variant

string

Variant name

Example:

"Var1"

cancels.cancel_lines.quantity

integer

Variant quantity

Required range: -2147483648 <= x <= 2147483647

Example:

3

cancels.cancel_lines.estimated_availability_date

string | null

Estimated availability date of variant

Example:

"12-12-2022"

cancels.order_id

integer

Order ID

Example:

"5465"

cancels.purchase_order_number

string

Purchase order number

Minimum length: 1

Example:

"CS192168"

cancels.reason

string

Cancellation reason

Minimum length: 1

Example:

"Incorrect"

cancels.acknowledged_at

string | null

Time of cancellation acknowledgement (UTC format)

Example:

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

shipments

object[]

Show child attributes

shipments.order_id

integer

required

Order ID

Example:

677

shipments.id

integer

Shipment ID

Example:

767

shipments.batch_number

integer | null

Batch number of shipment

Required range: -2147483648 <= x <= 2147483647

Example:

6

shipments.label_reference

string | null

Label reference

Maximum length: 30

Example:

"Sample label 123"

shipments.ordered_at

string

Time of shipment creation (UTC format)

Example:

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

shipments.customer_order_number

string

Customer order number

Minimum length: 1

Example:

"765637"

shipments.retailer_order_number

string

Retailer order number

Minimum length: 1

Example:

"66367"

shipments.purchase_order_number

string

Purchase order number

Minimum length: 1

Example:

"PO-576"

shipments.shipping_method

object

Show child attributes

shipments.shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 64

Example:

"White Glove Bronze"

shipments.shipping_method.code

string

required

Code of shipping method

Required string length: 1 - 64

Example:

"cory_white_glove"

shipments.shipping_method.id

integer

ID of shipping method

Example:

5

shipments.shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl (less than truck load)"

shipments.shipping_method.carrier

object

Show child attributes

shipments.shipping_method.carrier.id

integer

Carrier ID

Example:

229

shipments.shipping_method.carrier.name

string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

shipments.shipping_method.carrier.code

string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

shipments.shipping_method.generic_shipping_method

object

Show child attributes

shipments.shipping_method.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

shipments.shipping_method.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

shipments.shipping_method.generic_shipping_method.id

integer

ID of shipping method

Example:

5

shipments.shipping_method.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl"

shipments.shipping_account

object

Show child attributes

shipments.shipping_account.nickname

string

required

Nickname of shipping account

Required string length: 1 - 64

Example:

"Hobie FedEx"

shipments.shipping_account.id

integer

Shipping account ID

Example:

3

shipments.shipping_account.owner

string

Owner of shipping account

Example:

"Sample Owner"

shipments.shipping_account.carrier

object

Show child attributes

shipments.shipping_account.carrier.id

integer

Carrier ID

Example:

229

shipments.shipping_account.carrier.name

string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

shipments.shipping_account.carrier.code

string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

shipments.shipping_account.is_first_party_bill

boolean

true: is first party billed shipment <br /> false Is not first party bill

Example:

true

shipments.tracking_number

string | null

Tracking number for shipment

Maximum length: 128

Example:

"1Z9999999999999988"

shipments.tracking_url

string

URL for tracking shipment

Example:

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

shipments.tracking

object

Show child attributes

shipments.tracking.picked_up_at

string | null

Time of order pickup

Example:

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

shipments.tracking.delivered_at

string | null

Time of order delivery

Example:

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

shipments.tracking.tracking_details

object[]

Show child attributes

shipments.tracking.tracking_details.Time

string

required

Time of tracking (UTC format)

Example:

"10-10-2022"

shipments.tracking.tracking_details.status

string

required

Tracking status

Required string length: 1 - 32

Example:

"Delivered"

shipments.tracking.tracking_details.status_detail

string

required

Status details

Required string length: 1 - 64

Example:

"Out for delivery"

shipments.tracking.tracking_details.id

integer

Tracking ID

Example:

78895456

shipments.tracking.tracking_details.country

string | null

Country of delivery

Maximum length: 8

Example:

"USA"

shipments.tracking.tracking_details.state

string | null

State of delivery

Maximum length: 8

Example:

"New york"

shipments.tracking.tracking_details.city

string | null

City of delivery

Maximum length: 32

Example:

"New york"

shipments.tracking.tracking_details.postal_code

string | null

Postal code for delivery

Maximum length: 16

Example:

"123R32"

shipments.status

string

Status of shipment

Minimum length: 1

Example:

"Shipped"

shipments.is_acknowledged

boolean

true: Shipment is acknowledged <br /> false: Shipment is not acknowledged

Example:

true

shipments.has_commercial_invoice

boolean

true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice

Example:

true

shipments.canceled_at

string | null

Time of cancellation (UTC format)

Example:

null

shipments.sold_to

object

Show child attributes

shipments.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

shipments.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

shipments.sold_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

shipments.sold_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

shipments.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

shipments.sold_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

shipments.sold_to.id

integer

Address ID

Example:

10

shipments.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

shipments.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

shipments.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

shipments.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

shipments.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

shipments.sold_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

shipments.sold_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

shipments.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

shipments.ship_to

object

Show child attributes

shipments.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

shipments.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

shipments.ship_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

shipments.ship_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

shipments.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

shipments.ship_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

shipments.ship_to.id

integer

Address ID

Example:

10

shipments.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

shipments.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

shipments.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

shipments.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

shipments.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

shipments.ship_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

shipments.ship_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

shipments.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

shipments.ship_from

object

Show child attributes

shipments.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

shipments.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

shipments.ship_from.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

shipments.ship_from.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

shipments.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

shipments.ship_from.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

shipments.ship_from.id

integer

Address ID

Example:

10

shipments.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

shipments.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

shipments.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

shipments.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

shipments.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

shipments.ship_from.fax

string | null

Fax number

Maximum length: 32

Example:

null

shipments.ship_from.email

string | null

Contact email address

Maximum length: 128

Example:

null

shipments.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

shipments.ship_weight

number | null

Shipment weight

Example:

10

shipments.ship_width

number | null

Shipment width

Example:

1

shipments.ship_length

number | null

Shipment length

Example:

1

shipments.ship_height

number | null

Shipment height

Example:

1

shipments.ship_girth

string

Shipment girth

shipments.ship_volume

string

Shipment volume

Example:

4

shipments.valid_packing_slip

boolean

true: Shipment has valid packing slip <br /> false: Shipment does not valid packing slip

Example:

true

shipments.valid_shipping_label

boolean

true: Shipment has valid shipping label <br /> false: Shipment does not valid valid shipping label

Example:

true

shipments.shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum length: 64

Example:

"shp_3a61e10243da49ab92f0e3861d5d256b"

shipments.error_logs

object

Show child attributes

shipments.error_logs.id

integer

Error log ID

Example:

677

shipments.error_logs.message

string | null

Message in error log

Example:

"Sample errors to fix"

shipments.error_logs.count

integer

Count of error log

Example:

12

shipments.error_logs.created_at

string

Time of error log creation

Example:

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

shipments.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

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

shipments.closed_at

string | null

Time of shipment closure (UTC format)

Example:

null

shipments.delivered_at

string | null

Time of delivery (UTC format)

Example:

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

shipments.shipped_at

string | null

Time of shipping (UTC format)

Example:

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

shipments.updated_at

string

Time of shipment update (UTC format)

Example:

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

shipments.created_at

string

Time of shipment creation (UTC format)

Example:

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

shipments.shipment_lines

object[]

Show child attributes

shipments.shipment_lines.id

integer

Shipment line ID

Example:

1001

shipments.shipment_lines.order_line_number

string

Order line number

Example:

"1001"

shipments.shipment_lines.quantity

integer

Order quantity

Required range: -2147483648 <= x <= 2147483647

Example:

1

shipments.shipment_lines.part

integer

Internal only

Required range: -2147483648 <= x <= 2147483647

Example:

1

shipments.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

shipments.shipment_lines.updated_at

string

Time of last update

Example:

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

shipments.shipment_lines.variant

object

Show child attributes

shipments.shipment_lines.variant.id

integer

Variant ID

Example:

249

shipments.shipment_lines.variant.name

string | null

Variant name

Maximum length: 200

Example:

"Var45"

shipments.shipment_lines.variant.brand

object

Show child attributes

shipments.shipment_lines.variant.brand.code

string

required

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

Required string length: 1 - 64

Example:

"marla-store"

shipments.shipment_lines.variant.brand.id

integer

Vendor ID

Example:

456

shipments.shipment_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Store"

shipments.shipment_lines.variant.identifier

string | null

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

Maximum length: 128

Example:

"123-DEF12345"

shipments.shipment_lines.variant.brand_identifier

string

Brand identifier

Minimum length: 1

Example:

"HATR"

shipments.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 length: 64

Example:

555555555202

shipments.shipment_lines.variant.retailer_identifiers

object[]

Show child attributes

shipments.shipment_lines.variant.retailer_identifiers.id

integer

Retailer ID

Example:

5642

shipments.shipment_lines.variant.retailer_identifiers.retailer

object

Show child attributes

shipments.shipment_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

Example:

"SKU976"

shipments.shipment_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

Example:

"Retailer Sample"

shipments.signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

Example:

null

shipments.brand

object

Show child attributes

shipments.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

shipments.brand.id

integer

Vendor (brand) ID

Example:

500

shipments.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

shipments.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

shipments.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

shipments.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

shipments.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

shipments.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

shipments.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

shipments.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

shipments.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

shipments.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

shipments.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

shipments.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

shipments.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

shipments.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

shipments.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

shipments.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

shipments.invoice_number

string

Invoice number

Example:

"RC123456"

attachments

object[]

Show child attributes

attachments.id

integer

Attachment or document ID

Example:

268

attachments.content_type

integer

Content type

Example:

1

attachments.object_id

integer

Attachement object ID

Example:

666

attachments.file

string | null

File name

Example:

"Sample file"

attachments.uploaded_by

integer | null

User ID that uploaded the attachment

Example:

646

attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

Example:

"connections"

attachments.original_filename

string | null

Original file name

Maximum length: 255

Example:

"Sample1"

attachments.filename

string | null

File name used for sharing

Maximum length: 255

Example:

"Sample1"

attachments.tags

object[]

Show child attributes

attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

Example:

"demotag"

attachments.tags.id

integer

Attachment tag ID

Example:

432

attachments.url

string

URL of attachment

Minimum length: 1

Example:

"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"

memos

object[]

Show child attributes

memos.id

integer

Memo ID

Example:

1234

memos.text

string

Memo text

Example:

"Immediate requirement"

memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

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

memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

Example:

true

memos.created_by

object

Show child attributes

memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

memos.created_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

memos.created_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

memos.created_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

memos.created_at

string

Time of memo creation (UTC format)

Example:

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

memos.updated_at

string

Time of memo update (UTC format)

Example:

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

memos_count

integer

Total memos

Example:

1

unread_memos_count

integer

Number of unread memos

Example:

0

tags

object[]

Show child attributes

tags.id

integer

Object tag ID

Example:

536

tags.tag

string

Object tag

Example:

"Demo tag"

tags.created_by

object

Show child attributes

tags.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

tags.created_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

tags.created_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

tags.created_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

tags.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

tags.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

tags.created_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

tags.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

tags.created_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

tags.created_at

string

Time of object tag creation (UTC format)

Example:

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

tags.updated_at

string

Time of last update (UTC format)

Example:

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

gift_message

string

Gift message

Example:

"Gift"

fill_time

string | null

Fill time

Example:

null

invoices

object[]

Show child attributes

invoices.invoice_number

string

required

Invoice number

Required string length: 1 - 32

Example:

"RC123456"

invoices.id

integer

Invoice ID

Example:

1

invoices.retailer

object

Show child attributes

invoices.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

invoices.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

invoices.retailer.id

integer

Retailer ID

Example:

500

invoices.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

invoices.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

invoices.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

invoices.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

invoices.retailer.is_rcn_retailer

boolean

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

Example:

false

invoices.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

invoices.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

invoices.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

invoices.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

invoices.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

invoices.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

invoices.brand

object

Show child attributes

invoices.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

invoices.brand.id

integer

Vendor (brand) ID

Example:

500

invoices.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

invoices.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

invoices.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

invoices.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

invoices.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

invoices.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

invoices.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

invoices.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

invoices.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

invoices.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

invoices.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

invoices.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

invoices.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

invoices.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

invoices.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

invoices.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

invoices.connection_id

string

Connection ID

Example:

2

invoices.currency

object

Show child attributes

invoices.currency.id

integer

Currency ID

Example:

1

invoices.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

invoices.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

invoices.currency.unit

string

Currency unit

Example:

"USD"

invoices.terms_type

enum<string> | null

Types of invoice terms

Available options:

End of Month (EOM),

No Charge,

Consignment,

10 Days After End of Month (10 EOM),

Cash Discount Terms Apply,

Basic,

Fixed Date, Late Payment Penalty Applies,

Extended,

Discount Not Applicable,

Fixed Date,

Previously agreed upon

Example:

"Previously agreed upon"

invoices.terms_description

string | null

Description of invoice terms

Example:

"Previously agreed upon terms will apply"

invoices.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 <= x <= 2147483647

Example:

35

invoices.terms_date_due

string | null

Payment expected date

Example:

null

invoices.terms_discount_percent

string | null

Discount percentage on selected term

Example:

null

invoices.order_id

integer

Order ID related to invoice

Example:

"O-654"

invoices.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

Example:

"CO-435"

invoices.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

Example:

"PO-546"

invoices.status

enum<string>

Invoice status

Available options:

closed,

open

Example:

"closed"

invoices.remit_to

object

Show child attributes

invoices.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

invoices.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

invoices.remit_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

invoices.remit_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

invoices.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

invoices.remit_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

invoices.remit_to.id

integer

Address ID

Example:

10

invoices.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

invoices.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

invoices.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

invoices.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

invoices.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

invoices.remit_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

invoices.remit_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

invoices.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

invoices.ship_from

object

Show child attributes

invoices.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

invoices.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

invoices.ship_from.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

invoices.ship_from.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

invoices.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

invoices.ship_from.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

invoices.ship_from.id

integer

Address ID

Example:

10

invoices.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

invoices.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

invoices.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

invoices.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

invoices.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

invoices.ship_from.fax

string | null

Fax number

Maximum length: 32

Example:

null

invoices.ship_from.email

string | null

Contact email address

Maximum length: 128

Example:

null

invoices.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

invoices.sold_to

object

Show child attributes

invoices.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

invoices.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

invoices.sold_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

invoices.sold_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

invoices.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

invoices.sold_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

invoices.sold_to.id

integer

Address ID

Example:

10

invoices.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

invoices.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

invoices.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

invoices.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

invoices.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

invoices.sold_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

invoices.sold_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

invoices.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

invoices.ship_to

object

Show child attributes

invoices.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

invoices.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

invoices.ship_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

invoices.ship_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

invoices.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

invoices.ship_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

invoices.ship_to.id

integer

Address ID

Example:

10

invoices.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

invoices.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

invoices.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

invoices.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

invoices.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

invoices.ship_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

invoices.ship_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

invoices.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

invoices.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

Example:

"ALZ carrier"

invoices.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

Example:

"230F"

invoices.shipping_account_number

string | null

Shipping account number

Maximum length: 32

Example:

"SH879"

invoices.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

Example:

"Next day delivery"

invoices.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

Example:

"ND"

invoices.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

Example:

"1Z9999999999999988"

invoices.shipping_weight

string | null

Shipping weight

Example:

"7.00"

invoices.notes

string | null

Addition info adding to shipping

Example:

"Signature required"

invoices.invoiced_at

string | null

Time of invoice creation (UTC format)

Example:

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

invoices.ordered_at

string | null

Time of order finalization (UTC format)

Example:

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

invoices.shipped_at

string | null

Time of shipping (UTC format)

Example:

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

invoices.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

Example:

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

invoices.paid_at

string | null

Time of payment (UTC format)

Example:

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

invoices.closed_at

string | null

Time of complete invoice payment (UTC format)

Example:

null

invoices.canceled_at

string | null

Time of order cancellation (UTC format)

Example:

null

invoices.allowances

object[]

Show child attributes

invoices.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

Example:

"Sample-discount-allowance"

invoices.allowances.price

string

required

Allowance price

Example:

"12.10"

invoices.allowances.id

integer

Allowance ID

Example:

1

invoices.allowances.adjustment_code

object

Show child attributes

invoices.allowances.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

invoices.allowances.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

invoices.allowances.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

invoices.allowances.adjustment_code.id

integer

Adjustment ID

Example:

1

invoices.charges

object[]

Show child attributes

invoices.charges.description

string

required

Invoice description

Required string length: 1 - 128

Example:

"Sample invoice and its description"

invoices.charges.price

string

required

Invoice price

Example:

"23.45"

invoices.charges.id

integer

Invoice ID

Example:

654

invoices.charges.adjustment_code

object

Show child attributes

invoices.charges.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

invoices.charges.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

invoices.charges.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

invoices.charges.adjustment_code.id

integer

Adjustment ID

Example:

1

invoices.invoice_lines

object[]

Show child attributes

invoices.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 <= x <= 2147483647

Example:

45

invoices.invoice_lines.price

string

required

Discounted price

Example:

"12.00"

invoices.invoice_lines.id

integer

Invoice line ID

Example:

765

invoices.invoice_lines.variant

object

Show child attributes

invoices.invoice_lines.variant.id

integer

Variant ID

Example:

100024

invoices.invoice_lines.variant.name

string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

invoices.invoice_lines.variant.brand

object

Show child attributes

invoices.invoice_lines.variant.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

invoices.invoice_lines.variant.brand.id

integer

Vendor (brand) ID

Example:

500

invoices.invoice_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

invoices.invoice_lines.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

invoices.invoice_lines.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

invoices.invoice_lines.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

invoices.invoice_lines.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

invoices.invoice_lines.variant.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

invoices.invoice_lines.variant.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

invoices.invoice_lines.variant.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

invoices.invoice_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

invoices.invoice_lines.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

invoices.invoice_lines.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

invoices.invoice_lines.variant.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

invoices.invoice_lines.variant.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

invoices.invoice_lines.variant.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

invoices.invoice_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

invoices.invoice_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

invoices.invoice_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

invoices.invoice_lines.variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

Example:

"5000001"

invoices.invoice_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

invoices.invoice_lines.variant.cartons

object[]

Show child attributes

invoices.invoice_lines.variant.cartons.id

integer

Carton ID

Example:

48

invoices.invoice_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

invoices.invoice_lines.variant.cartons.length

string | null

Carton length

Example:

"1"

invoices.invoice_lines.variant.cartons.length_unit

string

Unit of length

Example:

"1"

invoices.invoice_lines.variant.cartons.width

string | null

Carton width

Example:

"1"

invoices.invoice_lines.variant.cartons.width_unit

string

Unit of width

Example:

"meter"

invoices.invoice_lines.variant.cartons.height

string | null

Carton height

Example:

"1"

invoices.invoice_lines.variant.cartons.height_unit

string

Unit of height

Example:

"meter"

invoices.invoice_lines.variant.cartons.weight

string | null

Carton weight

Example:

"15"

invoices.invoice_lines.variant.cartons.weight_unit

string

Unit of weight

Example:

"KG"

invoices.invoice_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

Example:

"1"

invoices.invoice_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

Example:

"1"

invoices.invoice_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

invoices.invoice_lines.variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

Example:

"Print"

invoices.invoice_lines.variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

Example:

"Large"

invoices.invoice_lines.variant.media

object[]

Show child attributes

invoices.invoice_lines.variant.media.id

integer

Variant ID

Example:

249

invoices.invoice_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

invoices.invoice_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

invoices.invoice_lines.variant.media.media

string

Variant images

Example:

"default"

invoices.invoice_lines.variant.media.priority

integer

Order in which the vendor prefers the images to be shown image 1 is shown first.

Required range: -2147483648 <= x <= 2147483647

Example:

1

invoices.invoice_lines.variant.media.url

string

URL of variant image

Example:

"192.168.99.100/media/default/original"

invoices.invoice_lines.variant.media.updated_at

string

Time of variant image update (UTC format)

Example:

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

invoices.invoice_lines.variant.media.created_at

string

Time of variant image creation (UTC format)

Example:

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

invoices.invoice_lines.variant.attributes

object[]

Show child attributes

invoices.invoice_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"size"

invoices.invoice_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Size"

invoices.invoice_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

invoices.invoice_lines.variant.attributes.id

integer

Attribute ID

Example:

44

invoices.invoice_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

invoices.invoice_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"general"

invoices.invoice_lines.variant.attributes.description

string | null

Attribute description

Example:

"demo product description"

invoices.invoice_lines.variant.attributes.units

string | null

Unit of the selected attribute type. If the attribute type is money, the unit is USD.

Maximum length: 32

Example:

"USD"

invoices.invoice_lines.variant.attributes.values

object

Show child attributes

invoices.invoice_lines.variant.ruleset_variants

object[]

Show child attributes

invoices.invoice_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

Example:

1232

invoices.invoice_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

invoices.invoice_lines.variant.ruleset_variants.ruleset

object

Show child attributes

invoices.invoice_lines.variant.ruleset_variants.results

string

Response

invoices.invoice_lines.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

Example:

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

invoices.invoice_lines.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

Example:

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

invoices.invoice_lines.variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

Example:

"21"

invoices.invoice_lines.variant.active_permit

object

Show child attributes

invoices.invoice_lines.variant.active_permit.id

integer

Permit ID

Example:

10104

invoices.invoice_lines.variant.active_permit.retailer

object

Show child attributes

invoices.invoice_lines.variant.active_permit.retailer_price

string | null

Retailer price of the variant

Example:

"12.99"

invoices.invoice_lines.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

Example:

"8.99"

invoices.invoice_lines.variant.active_permit.pricing

object

invoices.invoice_lines.variant.active_permit.attributes

object

invoices.invoice_lines.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

Example:

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

invoices.invoice_lines.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

Example:

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

invoices.invoice_lines.variant.active_permit.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

Example:

true

invoices.invoice_lines.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

Example:

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

invoices.invoice_lines.variant.active_permit.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

Example:

true

invoices.invoice_lines.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

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

invoices.invoice_lines.variant.permits

object[]

Show child attributes

invoices.invoice_lines.variant.permits.id

integer

Permit ID

Example:

10104

invoices.invoice_lines.variant.permits.retailer

object

Show child attributes

invoices.invoice_lines.variant.permits.retailer_price

string | null

Retailer price of the variant

Example:

"12.99"

invoices.invoice_lines.variant.permits.retailer_cost

string | null

Retailer cost of variant

Example:

"8.99"

invoices.invoice_lines.variant.permits.pricing

object

invoices.invoice_lines.variant.permits.attributes

object

invoices.invoice_lines.variant.permits.start_at

string | null

Time of permit start (UTC format)

Example:

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

invoices.invoice_lines.variant.permits.end_at

string | null

Time of permit end (UTC format)

Example:

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

invoices.invoice_lines.variant.permits.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

Example:

true

invoices.invoice_lines.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

Example:

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

invoices.invoice_lines.variant.permits.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

Example:

true

invoices.invoice_lines.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

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

invoices.invoice_lines.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

Example:

true

invoices.invoice_lines.variant.proposal_variant

object

Show child attributes

invoices.invoice_lines.variant.proposal_variant.id

integer

Proposal variant ID

Example:

3456

invoices.invoice_lines.variant.proposal_variant.pricing

string

Pricing of variant

Example:

"12.00"

invoices.invoice_lines.variant.proposal_variant.attributes

object[]

Show child attributes

invoices.invoice_lines.variant.proposal_variant.memos

object[]

Show child attributes

invoices.invoice_lines.variant.proposal_variant.issues

object[]

Show child attributes

invoices.invoice_lines.variant.proposal_variant.variant_id

integer

Variant ID

Example:

249

invoices.invoice_lines.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

Example:

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

invoices.invoice_lines.variant.proposal_variant.created_at

string

Time of creation (UTC format)

Example:

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

invoices.invoice_lines.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

Example:

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

invoices.invoice_lines.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

Example:

null

invoices.invoice_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

Example:

"Incomplete"

invoices.invoice_lines.variant.proposal_variant.reject

boolean

true: proposal is rejected <br /> false: proposal is not rejected

Example:

true

invoices.invoice_lines.variant.proposal_variant.approve

boolean

true: proposal is approved <br /> false: proposal is not approved

Example:

false

invoices.invoice_lines.variant.proposal_variant.delete

boolean

true: proposal is deleted <br /> false: proposal is not deleted

Example:

false

invoices.invoice_lines.variant.retailer_identifiers

object

Show child attributes

invoices.invoice_lines.variant.retailer_identifiers.id

integer

Retailer ID

Example:

5642

invoices.invoice_lines.variant.retailer_identifiers.retailer

object

Show child attributes

invoices.invoice_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

Example:

"SKU976"

invoices.invoice_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

Example:

"Retailer Sample"

invoices.invoice_lines.variant.retailer_categories

object

Show child attributes

invoices.invoice_lines.variant.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

invoices.invoice_lines.variant.retailer_categories.id

integer

Retailer category ID

Example:

453

invoices.invoice_lines.variant.retailer_categories.retailer

object

Show child attributes

invoices.invoice_lines.variant.inventory

object

Show child attributes

invoices.invoice_lines.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

Example:

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

invoices.invoice_lines.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

Example:

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

invoices.invoice_lines.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

Example:

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

invoices.invoice_lines.variant.inventory.sellable_updated_at

string

required

Time when product or variant was marked sellable (UTC format)

Example:

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

invoices.invoice_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

Example:

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

invoices.invoice_lines.variant.inventory.discontinued

boolean

true: Product is discontinued <br /> false: Product is active

Example:

true

invoices.invoice_lines.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

Example:

null

invoices.invoice_lines.variant.inventory.inventory

integer

Inventory of variant

Example:

0

invoices.invoice_lines.variant.inventory.sellable

string

yes: Variant is sellable <br /> No: Variant is not sellable

Example:

"No"

invoices.invoice_lines.variant.inventory.replenishable

boolean

true: product is replenishable <br /> false: product is not replenishable

Example:

true

invoices.invoice_lines.variant.inventory.locations

object[]

Show child attributes

invoices.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 <= x <= 2147483647

Example:

2

invoices.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

Example:

"Vend134"

invoices.invoice_lines.item_upc

string | null

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store

Maximum length: 32

Example:

"911911911112"

invoices.invoice_lines.name

string | null

Product name

Maximum length: 128

Example:

"SamPro1"

invoices.invoice_lines.description

string | null

Product description

Maximum length: 128

Example:

"Sample description of product"

invoices.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

Example:

null

invoices.invoice_lines.retail_price

string

Retail price

Example:

"14.00"

invoices.net_amount

string | null

Total invoice amount (exluding taxes)

Example:

"12.89"

invoices.due_amount

string | null

Pending amount

Example:

"2.89"

invoices.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

Example:

"2.89"

invoices.subtotal

string | null

Sub-total

Example:

"10.89"

invoices.tax

string | null

Total tax on the invoice

Example:

"2.00"

invoices.invoice_acceptance

object

Show child attributes

invoices.invoice_acceptance.id

integer

Invoice acceptance ID

Example:

565

invoices.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

invoices.invoice_acceptance.accepted_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

invoices.invoice_acceptance.accepted_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

invoices.invoice_acceptance.accepted_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

invoices.invoice_acceptance.accepted_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

invoices.invoice_acceptance.accepted_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

invoices.invoice_acceptance.accepted_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

invoices.invoice_acceptance.accepted_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

invoices.invoice_acceptance.accepted_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

invoices.invoice_acceptance.accepted_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

invoices.invoice_acceptance.rejected_by

object

Show child attributes

invoices.invoice_acceptance.rejected_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

invoices.invoice_acceptance.rejected_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

invoices.invoice_acceptance.rejected_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

invoices.invoice_acceptance.rejected_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

invoices.invoice_acceptance.rejected_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

invoices.invoice_acceptance.rejected_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

invoices.invoice_acceptance.rejected_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

invoices.invoice_acceptance.rejected_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

invoices.invoice_acceptance.rejected_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

invoices.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

Example:

"Incorrect"

invoices.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

Example:

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

invoices.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

Example:

null

signature

enum<string> | null

Represents whether signature is required

Available options:

required,

not_required,

adult

Example:

null

rmas

object[]

Show child attributes

rmas.order_id

integer

required

Order ID

Example:

1000

rmas.reason_id

integer

required

ID associated with return reason

Example:

344

rmas.id

integer

RMA ID. This ID is required in subsequent endpoints related to RMA.

Example:

4

rmas.purchase_order_number

string

Purchase order number

Minimum length: 1

Example:

"CS192168"

rmas.rma_number

string | null

RMA number

Maximum length: 32

Example:

"ABC123"

rmas.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

Example:

"Pending"

rmas.currency

object

Show child attributes

rmas.currency.id

integer

Currency ID

Example:

1

rmas.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

rmas.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

rmas.currency.unit

string

Currency unit

Example:

"USD"

rmas.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

Example:

"Retailer"

rmas.rmad_at

string | null

Time of RMA creation (UTC format)

Example:

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

rmas.approved_at

string | null

Time of RMA approval (UTC format)

Example:

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

rmas.rejected_at

string | null

Time of RMA rejection(UTC format)

Example:

null

rmas.ordered_at

string

Time of order finalization (UTC format)

Example:

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

rmas.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

Example:

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

rmas.rma_lines

object[]

Show child attributes

rmas.rma_lines.id

integer

RMA line ID

Example:

567

rmas.rma_lines.variant

object

Show child attributes

rmas.rma_lines.variant.id

integer

Variant ID

Example:

100024

rmas.rma_lines.variant.name

string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

rmas.rma_lines.variant.brand

object

Show child attributes

rmas.rma_lines.variant.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

rmas.rma_lines.variant.brand.id

integer

Vendor (brand) ID

Example:

500

rmas.rma_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

rmas.rma_lines.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

rmas.rma_lines.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

rmas.rma_lines.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

rmas.rma_lines.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

rmas.rma_lines.variant.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

rmas.rma_lines.variant.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

rmas.rma_lines.variant.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

rmas.rma_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

rmas.rma_lines.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

rmas.rma_lines.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

rmas.rma_lines.variant.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

rmas.rma_lines.variant.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

rmas.rma_lines.variant.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

rmas.rma_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

rmas.rma_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

rmas.rma_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

rmas.rma_lines.variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

Example:

"5000001"

rmas.rma_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

rmas.rma_lines.variant.cartons

object[]

Show child attributes

rmas.rma_lines.variant.cartons.id

integer

Carton ID

Example:

48

rmas.rma_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

rmas.rma_lines.variant.cartons.length

string | null

Carton length

Example:

"1"

rmas.rma_lines.variant.cartons.length_unit

string

Unit of length

Example:

"1"

rmas.rma_lines.variant.cartons.width

string | null

Carton width

Example:

"1"

rmas.rma_lines.variant.cartons.width_unit

string

Unit of width

Example:

"meter"

rmas.rma_lines.variant.cartons.height

string | null

Carton height

Example:

"1"

rmas.rma_lines.variant.cartons.height_unit

string

Unit of height

Example:

"meter"

rmas.rma_lines.variant.cartons.weight

string | null

Carton weight

Example:

"15"

rmas.rma_lines.variant.cartons.weight_unit

string

Unit of weight

Example:

"KG"

rmas.rma_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

Example:

"1"

rmas.rma_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

Example:

"1"

rmas.rma_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

rmas.rma_lines.variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

Example:

"Print"

rmas.rma_lines.variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

Example:

"Large"

rmas.rma_lines.variant.media

object[]

Show child attributes

rmas.rma_lines.variant.media.id

integer

Variant ID

Example:

249

rmas.rma_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

rmas.rma_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

rmas.rma_lines.variant.media.media

string

Variant images

Example:

"default"

rmas.rma_lines.variant.media.priority

integer

Order in which the vendor prefers the images to be shown image 1 is shown first.

Required range: -2147483648 <= x <= 2147483647

Example:

1

rmas.rma_lines.variant.media.url

string

URL of variant image

Example:

"192.168.99.100/media/default/original"

rmas.rma_lines.variant.media.updated_at

string

Time of variant image update (UTC format)

Example:

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

rmas.rma_lines.variant.media.created_at

string

Time of variant image creation (UTC format)

Example:

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

rmas.rma_lines.variant.attributes

object[]

Show child attributes

rmas.rma_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"size"

rmas.rma_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Size"

rmas.rma_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

rmas.rma_lines.variant.attributes.id

integer

Attribute ID

Example:

44

rmas.rma_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

rmas.rma_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"general"

rmas.rma_lines.variant.attributes.description

string | null

Attribute description

Example:

"demo product description"

rmas.rma_lines.variant.attributes.units

string | null

Unit of the selected attribute type. If the attribute type is money, the unit is USD.

Maximum length: 32

Example:

"USD"

rmas.rma_lines.variant.attributes.values

object

Show child attributes

rmas.rma_lines.variant.ruleset_variants

object[]

Show child attributes

rmas.rma_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

Example:

1232

rmas.rma_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

rmas.rma_lines.variant.ruleset_variants.ruleset

object

Show child attributes

rmas.rma_lines.variant.ruleset_variants.results

string

Response

rmas.rma_lines.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

Example:

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

rmas.rma_lines.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

Example:

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

rmas.rma_lines.variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

Example:

"21"

rmas.rma_lines.variant.active_permit

object

Show child attributes

rmas.rma_lines.variant.active_permit.id

integer

Permit ID

Example:

10104

rmas.rma_lines.variant.active_permit.retailer

object

Show child attributes

rmas.rma_lines.variant.active_permit.retailer_price

string | null

Retailer price of the variant

Example:

"12.99"

rmas.rma_lines.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

Example:

"8.99"

rmas.rma_lines.variant.active_permit.pricing

object

rmas.rma_lines.variant.active_permit.attributes

object

rmas.rma_lines.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

Example:

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

rmas.rma_lines.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

Example:

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

rmas.rma_lines.variant.active_permit.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

Example:

true

rmas.rma_lines.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

Example:

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

rmas.rma_lines.variant.active_permit.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

Example:

true

rmas.rma_lines.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

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

rmas.rma_lines.variant.permits

object[]

Show child attributes

rmas.rma_lines.variant.permits.id

integer

Permit ID

Example:

10104

rmas.rma_lines.variant.permits.retailer

object

Show child attributes

rmas.rma_lines.variant.permits.retailer_price

string | null

Retailer price of the variant

Example:

"12.99"

rmas.rma_lines.variant.permits.retailer_cost

string | null

Retailer cost of variant

Example:

"8.99"

rmas.rma_lines.variant.permits.pricing

object

rmas.rma_lines.variant.permits.attributes

object

rmas.rma_lines.variant.permits.start_at

string | null

Time of permit start (UTC format)

Example:

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

rmas.rma_lines.variant.permits.end_at

string | null

Time of permit end (UTC format)

Example:

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

rmas.rma_lines.variant.permits.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

Example:

true

rmas.rma_lines.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

Example:

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

rmas.rma_lines.variant.permits.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

Example:

true

rmas.rma_lines.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

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

rmas.rma_lines.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

Example:

true

rmas.rma_lines.variant.proposal_variant

object

Show child attributes

rmas.rma_lines.variant.proposal_variant.id

integer

Proposal variant ID

Example:

3456

rmas.rma_lines.variant.proposal_variant.pricing

string

Pricing of variant

Example:

"12.00"

rmas.rma_lines.variant.proposal_variant.attributes

object[]

Show child attributes

rmas.rma_lines.variant.proposal_variant.memos

object[]

Show child attributes

rmas.rma_lines.variant.proposal_variant.issues

object[]

Show child attributes

rmas.rma_lines.variant.proposal_variant.variant_id

integer

Variant ID

Example:

249

rmas.rma_lines.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

Example:

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

rmas.rma_lines.variant.proposal_variant.created_at

string

Time of creation (UTC format)

Example:

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

rmas.rma_lines.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

Example:

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

rmas.rma_lines.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

Example:

null

rmas.rma_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

Example:

"Incomplete"

rmas.rma_lines.variant.proposal_variant.reject

boolean

true: proposal is rejected <br /> false: proposal is not rejected

Example:

true

rmas.rma_lines.variant.proposal_variant.approve

boolean

true: proposal is approved <br /> false: proposal is not approved

Example:

false

rmas.rma_lines.variant.proposal_variant.delete

boolean

true: proposal is deleted <br /> false: proposal is not deleted

Example:

false

rmas.rma_lines.variant.retailer_identifiers

object

Show child attributes

rmas.rma_lines.variant.retailer_identifiers.id

integer

Retailer ID

Example:

5642

rmas.rma_lines.variant.retailer_identifiers.retailer

object

Show child attributes

rmas.rma_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

Example:

"SKU976"

rmas.rma_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

Example:

"Retailer Sample"

rmas.rma_lines.variant.retailer_categories

object

Show child attributes

rmas.rma_lines.variant.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

rmas.rma_lines.variant.retailer_categories.id

integer

Retailer category ID

Example:

453

rmas.rma_lines.variant.retailer_categories.retailer

object

Show child attributes

rmas.rma_lines.variant.inventory

object

Show child attributes

rmas.rma_lines.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

Example:

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

rmas.rma_lines.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

Example:

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

rmas.rma_lines.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

Example:

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

rmas.rma_lines.variant.inventory.sellable_updated_at

string

required

Time when product or variant was marked sellable (UTC format)

Example:

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

rmas.rma_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

Example:

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

rmas.rma_lines.variant.inventory.discontinued

boolean

true: Product is discontinued <br /> false: Product is active

Example:

true

rmas.rma_lines.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

Example:

null

rmas.rma_lines.variant.inventory.inventory

integer

Inventory of variant

Example:

0

rmas.rma_lines.variant.inventory.sellable

string

yes: Variant is sellable <br /> No: Variant is not sellable

Example:

"No"

rmas.rma_lines.variant.inventory.replenishable

boolean

true: product is replenishable <br /> false: product is not replenishable

Example:

true

rmas.rma_lines.variant.inventory.locations

object[]

Show child attributes

rmas.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 <= x <= 2147483647

Example:

20

rmas.rma_lines.quantity_shipped

integer

Quantity shipped

Example:

10

rmas.rma_lines.net_price

string

Net price

Example:

"12.00"

rmas.reason

string

Reason for return

Minimum length: 1

Example:

"Incorrect"

rmas.memos

object[]

Show child attributes

rmas.memos.id

integer

Memo ID

Example:

1234

rmas.memos.text

string

Memo text

Example:

"Immediate requirement"

rmas.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

rmas.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

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

rmas.memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

Example:

true

rmas.memos.created_by

object

Show child attributes

rmas.memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

rmas.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

rmas.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

rmas.memos.created_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

rmas.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

rmas.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

rmas.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

rmas.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

rmas.memos.created_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

rmas.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

rmas.memos.created_at

string

Time of memo creation (UTC format)

Example:

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

rmas.memos.updated_at

string

Time of memo update (UTC format)

Example:

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

rmas.attachments

object[]

Show child attributes

rmas.attachments.id

integer

Attachment or document ID

Example:

268

rmas.attachments.content_type

integer

Content type

Example:

1

rmas.attachments.object_id

integer

Attachement object ID

Example:

666

rmas.attachments.file

string | null

File name

Example:

"Sample file"

rmas.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

Example:

646

rmas.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

Example:

"connections"

rmas.attachments.original_filename

string | null

Original file name

Maximum length: 255

Example:

"Sample1"

rmas.attachments.filename

string | null

File name used for sharing

Maximum length: 255

Example:

"Sample1"

rmas.attachments.tags

object[]

Show child attributes

rmas.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

Example:

"demotag"

rmas.attachments.tags.id

integer

Attachment tag ID

Example:

432

rmas.attachments.url

string

URL of attachment

Minimum length: 1

Example:

"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"

rmas.retailer

object

Show child attributes

rmas.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

rmas.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

rmas.retailer.id

integer

Retailer ID

Example:

500

rmas.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

rmas.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

rmas.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

rmas.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

rmas.retailer.is_rcn_retailer

boolean

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

Example:

false

rmas.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

rmas.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

rmas.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

rmas.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

rmas.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

rmas.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

rmas.brand

object

Show child attributes

rmas.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

rmas.brand.id

integer

Vendor (brand) ID

Example:

500

rmas.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

rmas.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

rmas.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

rmas.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

rmas.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

rmas.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

rmas.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

rmas.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

rmas.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

rmas.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

rmas.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

rmas.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

rmas.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

rmas.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

rmas.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

rmas.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

rmas.total_amount

string

Total amount

Example:

"34.00"

rmas.credits

object[]

Show child attributes

rmas.credits.id

integer

Credit ID

Example:

20

rmas.credits.brand

object

Show child attributes

rmas.credits.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

rmas.credits.brand.id

integer

Vendor (brand) ID

Example:

500

rmas.credits.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

rmas.credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

rmas.credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

rmas.credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

rmas.credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

rmas.credits.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

rmas.credits.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

rmas.credits.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

rmas.credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

rmas.credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

rmas.credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

rmas.credits.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

rmas.credits.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

rmas.credits.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

rmas.credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

rmas.credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

rmas.credits.retailer

object

Show child attributes

rmas.credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

rmas.credits.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

rmas.credits.retailer.id

integer

Retailer ID

Example:

500

rmas.credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

rmas.credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

rmas.credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

rmas.credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

rmas.credits.retailer.is_rcn_retailer

boolean

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

Example:

false

rmas.credits.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

rmas.credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

rmas.credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

rmas.credits.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

rmas.credits.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

rmas.credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

rmas.credits.currency

object

Show child attributes

rmas.credits.currency.id

integer

Currency ID

Example:

1

rmas.credits.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

rmas.credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

rmas.credits.currency.unit

string

Currency unit

Example:

"USD"

rmas.credits.rma

object

Show child attributes

rmas.credits.rma.order_id

integer

required

Order ID

Example:

1000

rmas.credits.rma.reason_id

integer

required

ID associated with return reason

Example:

344

rmas.credits.rma.id

integer

RMA ID. This ID is required in subsequent endpoints related to RMA.

Example:

4

rmas.credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

Example:

"CS192168"

rmas.credits.rma.rma_number

string | null

RMA number

Maximum length: 32

Example:

"ABC123"

rmas.credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

Example:

"Pending"

rmas.credits.rma.currency

object

Show child attributes

rmas.credits.rma.currency.id

integer

Currency ID

Example:

1

rmas.credits.rma.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

rmas.credits.rma.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

rmas.credits.rma.currency.unit

string

Currency unit

Example:

"USD"

rmas.credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

Example:

"Retailer"

rmas.credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

Example:

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

rmas.credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

Example:

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

rmas.credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

Example:

null

rmas.credits.rma.ordered_at

string

Time of order finalization (UTC format)

Example:

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

rmas.credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

Example:

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

rmas.credits.rma.rma_lines

object[]

Show child attributes

rmas.credits.rma.rma_lines.id

integer

RMA line ID

Example:

567

rmas.credits.rma.rma_lines.variant

object

Show child attributes

rmas.credits.rma.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 <= x <= 2147483647

Example:

20

rmas.credits.rma.rma_lines.quantity_shipped

integer

Quantity shipped

Example:

10

rmas.credits.rma.rma_lines.net_price

string

Net price

Example:

"12.00"

rmas.credits.rma.reason

string

Reason for return

Minimum length: 1

Example:

"Incorrect"

rmas.credits.rma.memos

object[]

Show child attributes

rmas.credits.rma.memos.id

integer

Memo ID

Example:

1234

rmas.credits.rma.memos.text

string

Memo text

Example:

"Immediate requirement"

rmas.credits.rma.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

rmas.credits.rma.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

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

rmas.credits.rma.memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

Example:

true

rmas.credits.rma.memos.created_by

object

Show child attributes

rmas.credits.rma.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

rmas.credits.rma.memos.created_at

string

Time of memo creation (UTC format)

Example:

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

rmas.credits.rma.memos.updated_at

string

Time of memo update (UTC format)

Example:

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

rmas.credits.rma.attachments

object[]

Show child attributes

rmas.credits.rma.attachments.id

integer

Attachment or document ID

Example:

268

rmas.credits.rma.attachments.content_type

integer

Content type

Example:

1

rmas.credits.rma.attachments.object_id

integer

Attachement object ID

Example:

666

rmas.credits.rma.attachments.file

string | null

File name

Example:

"Sample file"

rmas.credits.rma.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

Example:

646

rmas.credits.rma.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

Example:

"connections"

rmas.credits.rma.attachments.original_filename

string | null

Original file name

Maximum length: 255

Example:

"Sample1"

rmas.credits.rma.attachments.filename

string | null

File name used for sharing

Maximum length: 255

Example:

"Sample1"

rmas.credits.rma.attachments.tags

object[]

Show child attributes

rmas.credits.rma.attachments.url

string

URL of attachment

Minimum length: 1

Example:

"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"

rmas.credits.rma.retailer

object

Show child attributes

rmas.credits.rma.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

rmas.credits.rma.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

rmas.credits.rma.retailer.id

integer

Retailer ID

Example:

500

rmas.credits.rma.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

rmas.credits.rma.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

rmas.credits.rma.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

rmas.credits.rma.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

rmas.credits.rma.retailer.is_rcn_retailer

boolean

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

Example:

false

rmas.credits.rma.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

rmas.credits.rma.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

rmas.credits.rma.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

rmas.credits.rma.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

rmas.credits.rma.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

rmas.credits.rma.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

rmas.credits.rma.brand

object

Show child attributes

rmas.credits.rma.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

rmas.credits.rma.brand.id

integer

Vendor (brand) ID

Example:

500

rmas.credits.rma.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

rmas.credits.rma.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

rmas.credits.rma.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

rmas.credits.rma.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

rmas.credits.rma.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

rmas.credits.rma.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

rmas.credits.rma.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

rmas.credits.rma.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

rmas.credits.rma.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

rmas.credits.rma.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

rmas.credits.rma.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

rmas.credits.rma.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

rmas.credits.rma.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

rmas.credits.rma.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

rmas.credits.rma.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

rmas.credits.rma.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

rmas.credits.rma.total_amount

string

Total amount

Example:

"34.00"

rmas.credits.rma.credits

object[]

Show child attributes

rmas.credits.rma.credits.id

integer

Credit ID

Example:

20

rmas.credits.rma.credits.brand

object

Show child attributes

rmas.credits.rma.credits.retailer

object

Show child attributes

rmas.credits.rma.credits.currency

object

Show child attributes

rmas.credits.rma.credits.rma

object

Show child attributes

rmas.credits.rma.credits.invoice

object

Show child attributes

rmas.credits.rma.credits.order

string

Order details

rmas.credits.rma.credits.credit_number

string | null

Credit number

Maximum length: 32

Example:

"849238"

rmas.credits.rma.credits.credit_lines

object[]

Show child attributes

rmas.credits.rma.credits.adjustments

object[]

Show child attributes

rmas.credits.rma.credits.acknowledged_at

string | null

Time of credit acknowledgement

Example:

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

rmas.credits.rma.credits.credited_at

string | null

Time of credit (UTC format)

Example:

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

rmas.credits.rma.credits.created_at

string

Time of creation (UTC format)

Example:

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

rmas.credits.rma.credits.subtotal

string

Subtotal amount

Example:

"20.00"

rmas.credits.rma.credits.credit_amount

string

Credit amount

Example:

"24.00"

rmas.credits.invoice

object

Show child attributes

rmas.credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

Example:

"RC123456"

rmas.credits.invoice.id

integer

Invoice ID

Example:

1

rmas.credits.invoice.retailer

object

Show child attributes

rmas.credits.invoice.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

rmas.credits.invoice.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

rmas.credits.invoice.retailer.id

integer

Retailer ID

Example:

500

rmas.credits.invoice.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

rmas.credits.invoice.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

rmas.credits.invoice.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

rmas.credits.invoice.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

rmas.credits.invoice.retailer.is_rcn_retailer

boolean

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

Example:

false

rmas.credits.invoice.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

rmas.credits.invoice.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

rmas.credits.invoice.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

rmas.credits.invoice.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

rmas.credits.invoice.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

rmas.credits.invoice.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

rmas.credits.invoice.brand

object

Show child attributes

rmas.credits.invoice.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

rmas.credits.invoice.brand.id

integer

Vendor (brand) ID

Example:

500

rmas.credits.invoice.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

rmas.credits.invoice.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

rmas.credits.invoice.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

rmas.credits.invoice.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

rmas.credits.invoice.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

rmas.credits.invoice.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

rmas.credits.invoice.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

rmas.credits.invoice.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

rmas.credits.invoice.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

rmas.credits.invoice.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

rmas.credits.invoice.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

rmas.credits.invoice.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

rmas.credits.invoice.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

rmas.credits.invoice.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

rmas.credits.invoice.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

rmas.credits.invoice.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

rmas.credits.invoice.connection_id

string

Connection ID

Example:

2

rmas.credits.invoice.currency

object

Show child attributes

rmas.credits.invoice.currency.id

integer

Currency ID

Example:

1

rmas.credits.invoice.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

rmas.credits.invoice.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

rmas.credits.invoice.currency.unit

string

Currency unit

Example:

"USD"

rmas.credits.invoice.terms_type

enum<string> | null

Types of invoice terms

Available options:

End of Month (EOM),

No Charge,

Consignment,

10 Days After End of Month (10 EOM),

Cash Discount Terms Apply,

Basic,

Fixed Date, Late Payment Penalty Applies,

Extended,

Discount Not Applicable,

Fixed Date,

Previously agreed upon

Example:

"Previously agreed upon"

rmas.credits.invoice.terms_description

string | null

Description of invoice terms

Example:

"Previously agreed upon terms will apply"

rmas.credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 <= x <= 2147483647

Example:

35

rmas.credits.invoice.terms_date_due

string | null

Payment expected date

Example:

null

rmas.credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

Example:

null

rmas.credits.invoice.order_id

integer

Order ID related to invoice

Example:

"O-654"

rmas.credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

Example:

"CO-435"

rmas.credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

Example:

"PO-546"

rmas.credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

Example:

"closed"

rmas.credits.invoice.remit_to

object

Show child attributes

rmas.credits.invoice.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

rmas.credits.invoice.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

rmas.credits.invoice.remit_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

rmas.credits.invoice.remit_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

rmas.credits.invoice.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

rmas.credits.invoice.remit_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

rmas.credits.invoice.remit_to.id

integer

Address ID

Example:

10

rmas.credits.invoice.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

rmas.credits.invoice.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

rmas.credits.invoice.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

rmas.credits.invoice.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

rmas.credits.invoice.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

rmas.credits.invoice.remit_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

rmas.credits.invoice.remit_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

rmas.credits.invoice.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

rmas.credits.invoice.ship_from

object

Show child attributes

rmas.credits.invoice.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

rmas.credits.invoice.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

rmas.credits.invoice.ship_from.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

rmas.credits.invoice.ship_from.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

rmas.credits.invoice.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

rmas.credits.invoice.ship_from.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

rmas.credits.invoice.ship_from.id

integer

Address ID

Example:

10

rmas.credits.invoice.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

rmas.credits.invoice.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

rmas.credits.invoice.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

rmas.credits.invoice.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

rmas.credits.invoice.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

rmas.credits.invoice.ship_from.fax

string | null

Fax number

Maximum length: 32

Example:

null

rmas.credits.invoice.ship_from.email

string | null

Contact email address

Maximum length: 128

Example:

null

rmas.credits.invoice.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

rmas.credits.invoice.sold_to

object

Show child attributes

rmas.credits.invoice.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

rmas.credits.invoice.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

rmas.credits.invoice.sold_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

rmas.credits.invoice.sold_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

rmas.credits.invoice.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

rmas.credits.invoice.sold_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

rmas.credits.invoice.sold_to.id

integer

Address ID

Example:

10

rmas.credits.invoice.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

rmas.credits.invoice.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

rmas.credits.invoice.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

rmas.credits.invoice.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

rmas.credits.invoice.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

rmas.credits.invoice.sold_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

rmas.credits.invoice.sold_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

rmas.credits.invoice.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

rmas.credits.invoice.ship_to

object

Show child attributes

rmas.credits.invoice.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

rmas.credits.invoice.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

rmas.credits.invoice.ship_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

rmas.credits.invoice.ship_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

rmas.credits.invoice.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

rmas.credits.invoice.ship_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

rmas.credits.invoice.ship_to.id

integer

Address ID

Example:

10

rmas.credits.invoice.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

rmas.credits.invoice.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

rmas.credits.invoice.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

rmas.credits.invoice.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

rmas.credits.invoice.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

rmas.credits.invoice.ship_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

rmas.credits.invoice.ship_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

rmas.credits.invoice.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

rmas.credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

Example:

"ALZ carrier"

rmas.credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

Example:

"230F"

rmas.credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

Example:

"SH879"

rmas.credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

Example:

"Next day delivery"

rmas.credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

Example:

"ND"

rmas.credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

Example:

"1Z9999999999999988"

rmas.credits.invoice.shipping_weight

string | null

Shipping weight

Example:

"7.00"

rmas.credits.invoice.notes

string | null

Addition info adding to shipping

Example:

"Signature required"

rmas.credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

Example:

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

rmas.credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

Example:

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

rmas.credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

Example:

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

rmas.credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

Example:

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

rmas.credits.invoice.paid_at

string | null

Time of payment (UTC format)

Example:

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

rmas.credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

Example:

null

rmas.credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

Example:

null

rmas.credits.invoice.allowances

object[]

Show child attributes

rmas.credits.invoice.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

Example:

"Sample-discount-allowance"

rmas.credits.invoice.allowances.price

string

required

Allowance price

Example:

"12.10"

rmas.credits.invoice.allowances.id

integer

Allowance ID

Example:

1

rmas.credits.invoice.allowances.adjustment_code

object

Show child attributes

rmas.credits.invoice.charges

object[]

Show child attributes

rmas.credits.invoice.charges.description

string

required

Invoice description

Required string length: 1 - 128

Example:

"Sample invoice and its description"

rmas.credits.invoice.charges.price

string

required

Invoice price

Example:

"23.45"

rmas.credits.invoice.charges.id

integer

Invoice ID

Example:

654

rmas.credits.invoice.charges.adjustment_code

object

Show child attributes

rmas.credits.invoice.invoice_lines

object[]

Show child attributes

rmas.credits.invoice.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 <= x <= 2147483647

Example:

45

rmas.credits.invoice.invoice_lines.price

string

required

Discounted price

Example:

"12.00"

rmas.credits.invoice.invoice_lines.id

integer

Invoice line ID

Example:

765

rmas.credits.invoice.invoice_lines.variant

object

Show child attributes

rmas.credits.invoice.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 <= x <= 2147483647

Example:

2

rmas.credits.invoice.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

Example:

"Vend134"

rmas.credits.invoice.invoice_lines.item_upc

string | null

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store

Maximum length: 32

Example:

"911911911112"

rmas.credits.invoice.invoice_lines.name

string | null

Product name

Maximum length: 128

Example:

"SamPro1"

rmas.credits.invoice.invoice_lines.description

string | null

Product description

Maximum length: 128

Example:

"Sample description of product"

rmas.credits.invoice.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

Example:

null

rmas.credits.invoice.invoice_lines.retail_price

string

Retail price

Example:

"14.00"

rmas.credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

Example:

"12.89"

rmas.credits.invoice.due_amount

string | null

Pending amount

Example:

"2.89"

rmas.credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

Example:

"2.89"

rmas.credits.invoice.subtotal

string | null

Sub-total

Example:

"10.89"

rmas.credits.invoice.tax

string | null

Total tax on the invoice

Example:

"2.00"

rmas.credits.invoice.invoice_acceptance

object

Show child attributes

rmas.credits.invoice.invoice_acceptance.id

integer

Invoice acceptance ID

Example:

565

rmas.credits.invoice.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

rmas.credits.invoice.invoice_acceptance.rejected_by

object

Show child attributes

rmas.credits.invoice.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

Example:

"Incorrect"

rmas.credits.invoice.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

Example:

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

rmas.credits.invoice.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

Example:

null

rmas.credits.order

string

Order details

rmas.credits.credit_number

string | null

Credit number

Maximum length: 32

Example:

"849238"

rmas.credits.credit_lines

object[]

Show child attributes

rmas.credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 <= x <= 2147483647

Example:

10

rmas.credits.credit_lines.id

integer

Credit line ID

Example:

566

rmas.credits.credit_lines.variant

object

Show child attributes

rmas.credits.credit_lines.variant.id

integer

Variant ID

Example:

100024

rmas.credits.credit_lines.variant.name

string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

rmas.credits.credit_lines.variant.brand

object

Show child attributes

rmas.credits.credit_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

rmas.credits.credit_lines.variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

Example:

"5000001"

rmas.credits.credit_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

rmas.credits.credit_lines.variant.cartons

object[]

Show child attributes

rmas.credits.credit_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

rmas.credits.credit_lines.variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

Example:

"Print"

rmas.credits.credit_lines.variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

Example:

"Large"

rmas.credits.credit_lines.variant.media

object[]

Show child attributes

rmas.credits.credit_lines.variant.attributes

object[]

Show child attributes

rmas.credits.credit_lines.variant.ruleset_variants

object[]

Show child attributes

rmas.credits.credit_lines.variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

Example:

"21"

rmas.credits.credit_lines.variant.active_permit

object

Show child attributes

rmas.credits.credit_lines.variant.permits

object[]

Show child attributes

rmas.credits.credit_lines.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

Example:

true

rmas.credits.credit_lines.variant.proposal_variant

object

Show child attributes

rmas.credits.credit_lines.variant.retailer_identifiers

object

Show child attributes

rmas.credits.credit_lines.variant.retailer_categories

object

Show child attributes

rmas.credits.credit_lines.variant.inventory

object

Show child attributes

rmas.credits.credit_lines.net_price

string

Credit line net price

Example:

"12.99"

rmas.credits.adjustments

object[]

Show child attributes

rmas.credits.adjustments.id

integer

Adjustment ID

Example:

566

rmas.credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

Example:

"Sample description for adjustment"

rmas.credits.adjustments.net_price

string

Adjustment net price

Example:

"1.00"

rmas.credits.acknowledged_at

string | null

Time of credit acknowledgement

Example:

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

rmas.credits.credited_at

string | null

Time of credit (UTC format)

Example:

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

rmas.credits.created_at

string

Time of creation (UTC format)

Example:

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

rmas.credits.subtotal

string

Subtotal amount

Example:

"20.00"

rmas.credits.credit_amount

string

Credit amount

Example:

"24.00"

credits

object[]

Show child attributes

credits.id

integer

Credit ID

Example:

20

credits.brand

object

Show child attributes

credits.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

credits.brand.id

integer

Vendor (brand) ID

Example:

500

credits.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

credits.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

credits.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

credits.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

credits.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

credits.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

credits.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

credits.retailer

object

Show child attributes

credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

credits.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

credits.retailer.id

integer

Retailer ID

Example:

500

credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

credits.retailer.is_rcn_retailer

boolean

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

Example:

false

credits.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

credits.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

credits.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

credits.currency

object

Show child attributes

credits.currency.id

integer

Currency ID

Example:

1

credits.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

credits.currency.unit

string

Currency unit

Example:

"USD"

credits.rma

object

Show child attributes

credits.rma.order_id

integer

required

Order ID

Example:

1000

credits.rma.reason_id

integer

required

ID associated with return reason

Example:

344

credits.rma.id

integer

RMA ID. This ID is required in subsequent endpoints related to RMA.

Example:

4

credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

Example:

"CS192168"

credits.rma.rma_number

string | null

RMA number

Maximum length: 32

Example:

"ABC123"

credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

Example:

"Pending"

credits.rma.currency

object

Show child attributes

credits.rma.currency.id

integer

Currency ID

Example:

1

credits.rma.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

credits.rma.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

credits.rma.currency.unit

string

Currency unit

Example:

"USD"

credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

Example:

"Retailer"

credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

Example:

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

credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

Example:

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

credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

Example:

null

credits.rma.ordered_at

string

Time of order finalization (UTC format)

Example:

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

credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

Example:

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

credits.rma.rma_lines

object[]

Show child attributes

credits.rma.rma_lines.id

integer

RMA line ID

Example:

567

credits.rma.rma_lines.variant

object

Show child attributes

credits.rma.rma_lines.variant.id

integer

Variant ID

Example:

100024

credits.rma.rma_lines.variant.name

string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

credits.rma.rma_lines.variant.brand

object

Show child attributes

credits.rma.rma_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

credits.rma.rma_lines.variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

Example:

"5000001"

credits.rma.rma_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

credits.rma.rma_lines.variant.cartons

object[]

Show child attributes

credits.rma.rma_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

credits.rma.rma_lines.variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

Example:

"Print"

credits.rma.rma_lines.variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

Example:

"Large"

credits.rma.rma_lines.variant.media

object[]

Show child attributes

credits.rma.rma_lines.variant.attributes

object[]

Show child attributes

credits.rma.rma_lines.variant.ruleset_variants

object[]

Show child attributes

credits.rma.rma_lines.variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

Example:

"21"

credits.rma.rma_lines.variant.active_permit

object

Show child attributes

credits.rma.rma_lines.variant.permits

object[]

Show child attributes

credits.rma.rma_lines.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

Example:

true

credits.rma.rma_lines.variant.proposal_variant

object

Show child attributes

credits.rma.rma_lines.variant.retailer_identifiers

object

Show child attributes

credits.rma.rma_lines.variant.retailer_categories

object

Show child attributes

credits.rma.rma_lines.variant.inventory

object

Show child attributes

credits.rma.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 <= x <= 2147483647

Example:

20

credits.rma.rma_lines.quantity_shipped

integer

Quantity shipped

Example:

10

credits.rma.rma_lines.net_price

string

Net price

Example:

"12.00"

credits.rma.reason

string

Reason for return

Minimum length: 1

Example:

"Incorrect"

credits.rma.memos

object[]

Show child attributes

credits.rma.memos.id

integer

Memo ID

Example:

1234

credits.rma.memos.text

string

Memo text

Example:

"Immediate requirement"

credits.rma.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

credits.rma.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

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

credits.rma.memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

Example:

true

credits.rma.memos.created_by

object

Show child attributes

credits.rma.memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

credits.rma.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

credits.rma.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

credits.rma.memos.created_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

credits.rma.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

credits.rma.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

credits.rma.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

credits.rma.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

credits.rma.memos.created_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

credits.rma.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

credits.rma.memos.created_at

string

Time of memo creation (UTC format)

Example:

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

credits.rma.memos.updated_at

string

Time of memo update (UTC format)

Example:

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

credits.rma.attachments

object[]

Show child attributes

credits.rma.attachments.id

integer

Attachment or document ID

Example:

268

credits.rma.attachments.content_type

integer

Content type

Example:

1

credits.rma.attachments.object_id

integer

Attachement object ID

Example:

666

credits.rma.attachments.file

string | null

File name

Example:

"Sample file"

credits.rma.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

Example:

646

credits.rma.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

Example:

"connections"

credits.rma.attachments.original_filename

string | null

Original file name

Maximum length: 255

Example:

"Sample1"

credits.rma.attachments.filename

string | null

File name used for sharing

Maximum length: 255

Example:

"Sample1"

credits.rma.attachments.tags

object[]

Show child attributes

credits.rma.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

Example:

"demotag"

credits.rma.attachments.tags.id

integer

Attachment tag ID

Example:

432

credits.rma.attachments.url

string

URL of attachment

Minimum length: 1

Example:

"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"

credits.rma.retailer

object

Show child attributes

credits.rma.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

credits.rma.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

credits.rma.retailer.id

integer

Retailer ID

Example:

500

credits.rma.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

credits.rma.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

credits.rma.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

credits.rma.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

credits.rma.retailer.is_rcn_retailer

boolean

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

Example:

false

credits.rma.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

credits.rma.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

credits.rma.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

credits.rma.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

credits.rma.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

credits.rma.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

credits.rma.brand

object

Show child attributes

credits.rma.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

credits.rma.brand.id

integer

Vendor (brand) ID

Example:

500

credits.rma.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

credits.rma.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

credits.rma.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

credits.rma.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

credits.rma.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

credits.rma.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

credits.rma.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

credits.rma.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

credits.rma.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

credits.rma.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

credits.rma.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

credits.rma.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

credits.rma.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

credits.rma.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

credits.rma.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

credits.rma.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

credits.rma.total_amount

string

Total amount

Example:

"34.00"

credits.rma.credits

object[]

Show child attributes

credits.rma.credits.id

integer

Credit ID

Example:

20

credits.rma.credits.brand

object

Show child attributes

credits.rma.credits.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

credits.rma.credits.brand.id

integer

Vendor (brand) ID

Example:

500

credits.rma.credits.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

credits.rma.credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

credits.rma.credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

credits.rma.credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

credits.rma.credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

credits.rma.credits.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

credits.rma.credits.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

credits.rma.credits.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

credits.rma.credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

credits.rma.credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

credits.rma.credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

credits.rma.credits.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

credits.rma.credits.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

credits.rma.credits.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

credits.rma.credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

credits.rma.credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

credits.rma.credits.retailer

object

Show child attributes

credits.rma.credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

credits.rma.credits.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

credits.rma.credits.retailer.id

integer

Retailer ID

Example:

500

credits.rma.credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

credits.rma.credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

credits.rma.credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

credits.rma.credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

credits.rma.credits.retailer.is_rcn_retailer

boolean

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

Example:

false

credits.rma.credits.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

credits.rma.credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

credits.rma.credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

credits.rma.credits.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

credits.rma.credits.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

credits.rma.credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

credits.rma.credits.currency

object

Show child attributes

credits.rma.credits.currency.id

integer

Currency ID

Example:

1

credits.rma.credits.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

credits.rma.credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

credits.rma.credits.currency.unit

string

Currency unit

Example:

"USD"

credits.rma.credits.rma

object

Show child attributes

credits.rma.credits.rma.order_id

integer

required

Order ID

Example:

1000

credits.rma.credits.rma.reason_id

integer

required

ID associated with return reason

Example:

344

credits.rma.credits.rma.id

integer

RMA ID. This ID is required in subsequent endpoints related to RMA.

Example:

4

credits.rma.credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

Example:

"CS192168"

credits.rma.credits.rma.rma_number

string | null

RMA number

Maximum length: 32

Example:

"ABC123"

credits.rma.credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

Example:

"Pending"

credits.rma.credits.rma.currency

object

Show child attributes

credits.rma.credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

Example:

"Retailer"

credits.rma.credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

Example:

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

credits.rma.credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

Example:

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

credits.rma.credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

Example:

null

credits.rma.credits.rma.ordered_at

string

Time of order finalization (UTC format)

Example:

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

credits.rma.credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

Example:

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

credits.rma.credits.rma.rma_lines

object[]

Show child attributes

credits.rma.credits.rma.reason

string

Reason for return

Minimum length: 1

Example:

"Incorrect"

credits.rma.credits.rma.memos

object[]

Show child attributes

credits.rma.credits.rma.attachments

object[]

Show child attributes

credits.rma.credits.rma.retailer

object

Show child attributes

credits.rma.credits.rma.brand

object

Show child attributes

credits.rma.credits.rma.total_amount

string

Total amount

Example:

"34.00"

credits.rma.credits.rma.credits

object[]

Show child attributes

credits.rma.credits.invoice

object

Show child attributes

credits.rma.credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

Example:

"RC123456"

credits.rma.credits.invoice.id

integer

Invoice ID

Example:

1

credits.rma.credits.invoice.retailer

object

Show child attributes

credits.rma.credits.invoice.brand

object

Show child attributes

credits.rma.credits.invoice.connection_id

string

Connection ID

Example:

2

credits.rma.credits.invoice.currency

object

Show child attributes

credits.rma.credits.invoice.terms_type

enum<string> | null

Types of invoice terms

Available options:

End of Month (EOM),

No Charge,

Consignment,

10 Days After End of Month (10 EOM),

Cash Discount Terms Apply,

Basic,

Fixed Date, Late Payment Penalty Applies,

Extended,

Discount Not Applicable,

Fixed Date,

Previously agreed upon

Example:

"Previously agreed upon"

credits.rma.credits.invoice.terms_description

string | null

Description of invoice terms

Example:

"Previously agreed upon terms will apply"

credits.rma.credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 <= x <= 2147483647

Example:

35

credits.rma.credits.invoice.terms_date_due

string | null

Payment expected date

Example:

null

credits.rma.credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

Example:

null

credits.rma.credits.invoice.order_id

integer

Order ID related to invoice

Example:

"O-654"

credits.rma.credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

Example:

"CO-435"

credits.rma.credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

Example:

"PO-546"

credits.rma.credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

Example:

"closed"

credits.rma.credits.invoice.remit_to

object

Show child attributes

credits.rma.credits.invoice.ship_from

object

Show child attributes

credits.rma.credits.invoice.sold_to

object

Show child attributes

credits.rma.credits.invoice.ship_to

object

Show child attributes

credits.rma.credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

Example:

"ALZ carrier"

credits.rma.credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

Example:

"230F"

credits.rma.credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

Example:

"SH879"

credits.rma.credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

Example:

"Next day delivery"

credits.rma.credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

Example:

"ND"

credits.rma.credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

Example:

"1Z9999999999999988"

credits.rma.credits.invoice.shipping_weight

string | null

Shipping weight

Example:

"7.00"

credits.rma.credits.invoice.notes

string | null

Addition info adding to shipping

Example:

"Signature required"

credits.rma.credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

Example:

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

credits.rma.credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

Example:

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

credits.rma.credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

Example:

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

credits.rma.credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

Example:

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

credits.rma.credits.invoice.paid_at

string | null

Time of payment (UTC format)

Example:

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

credits.rma.credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

Example:

null

credits.rma.credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

Example:

null

credits.rma.credits.invoice.allowances

object[]

Show child attributes

credits.rma.credits.invoice.charges

object[]

Show child attributes

credits.rma.credits.invoice.invoice_lines

object[]

Show child attributes

credits.rma.credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

Example:

"12.89"

credits.rma.credits.invoice.due_amount

string | null

Pending amount

Example:

"2.89"

credits.rma.credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

Example:

"2.89"

credits.rma.credits.invoice.subtotal

string | null

Sub-total

Example:

"10.89"

credits.rma.credits.invoice.tax

string | null

Total tax on the invoice

Example:

"2.00"

credits.rma.credits.invoice.invoice_acceptance

object

Show child attributes

credits.rma.credits.order

string

Order details

credits.rma.credits.credit_number

string | null

Credit number

Maximum length: 32

Example:

"849238"

credits.rma.credits.credit_lines

object[]

Show child attributes

credits.rma.credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 <= x <= 2147483647

Example:

10

credits.rma.credits.credit_lines.id

integer

Credit line ID

Example:

566

credits.rma.credits.credit_lines.variant

object

Show child attributes

credits.rma.credits.credit_lines.net_price

string

Credit line net price

Example:

"12.99"

credits.rma.credits.adjustments

object[]

Show child attributes

credits.rma.credits.adjustments.id

integer

Adjustment ID

Example:

566

credits.rma.credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

Example:

"Sample description for adjustment"

credits.rma.credits.adjustments.net_price

string

Adjustment net price

Example:

"1.00"

credits.rma.credits.acknowledged_at

string | null

Time of credit acknowledgement

Example:

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

credits.rma.credits.credited_at

string | null

Time of credit (UTC format)

Example:

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

credits.rma.credits.created_at

string

Time of creation (UTC format)

Example:

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

credits.rma.credits.subtotal

string

Subtotal amount

Example:

"20.00"

credits.rma.credits.credit_amount

string

Credit amount

Example:

"24.00"

credits.invoice

object

Show child attributes

credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

Example:

"RC123456"

credits.invoice.id

integer

Invoice ID

Example:

1

credits.invoice.retailer

object

Show child attributes

credits.invoice.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

credits.invoice.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

credits.invoice.retailer.id

integer

Retailer ID

Example:

500

credits.invoice.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

credits.invoice.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

credits.invoice.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

credits.invoice.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

credits.invoice.retailer.is_rcn_retailer

boolean

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

Example:

false

credits.invoice.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

credits.invoice.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

credits.invoice.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

credits.invoice.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

credits.invoice.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

credits.invoice.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

credits.invoice.brand

object

Show child attributes

credits.invoice.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

credits.invoice.brand.id

integer

Vendor (brand) ID

Example:

500

credits.invoice.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

credits.invoice.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

credits.invoice.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

credits.invoice.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

credits.invoice.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

credits.invoice.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

credits.invoice.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

credits.invoice.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

credits.invoice.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

credits.invoice.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

credits.invoice.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

credits.invoice.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

credits.invoice.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

credits.invoice.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

credits.invoice.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

credits.invoice.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

credits.invoice.connection_id

string

Connection ID

Example:

2

credits.invoice.currency

object

Show child attributes

credits.invoice.currency.id

integer

Currency ID

Example:

1

credits.invoice.currency.name

string

Currency name

Maximum length: 200

Example:

"United States Dollar"

credits.invoice.currency.symbol

string | null

Currency symbol

Maximum length: 5

Example:

"$"

credits.invoice.currency.unit

string

Currency unit

Example:

"USD"

credits.invoice.terms_type

enum<string> | null

Types of invoice terms

Available options:

End of Month (EOM),

No Charge,

Consignment,

10 Days After End of Month (10 EOM),

Cash Discount Terms Apply,

Basic,

Fixed Date, Late Payment Penalty Applies,

Extended,

Discount Not Applicable,

Fixed Date,

Previously agreed upon

Example:

"Previously agreed upon"

credits.invoice.terms_description

string | null

Description of invoice terms

Example:

"Previously agreed upon terms will apply"

credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 <= x <= 2147483647

Example:

35

credits.invoice.terms_date_due

string | null

Payment expected date

Example:

null

credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

Example:

null

credits.invoice.order_id

integer

Order ID related to invoice

Example:

"O-654"

credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

Example:

"CO-435"

credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

Example:

"PO-546"

credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

Example:

"closed"

credits.invoice.remit_to

object

Show child attributes

credits.invoice.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

credits.invoice.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

credits.invoice.remit_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

credits.invoice.remit_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

credits.invoice.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

credits.invoice.remit_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

credits.invoice.remit_to.id

integer

Address ID

Example:

10

credits.invoice.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

credits.invoice.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

credits.invoice.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

credits.invoice.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

credits.invoice.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

credits.invoice.remit_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

credits.invoice.remit_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

credits.invoice.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

credits.invoice.ship_from

object

Show child attributes

credits.invoice.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

credits.invoice.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

credits.invoice.ship_from.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

credits.invoice.ship_from.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

credits.invoice.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

credits.invoice.ship_from.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

credits.invoice.ship_from.id

integer

Address ID

Example:

10

credits.invoice.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

credits.invoice.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

credits.invoice.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

credits.invoice.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

credits.invoice.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

credits.invoice.ship_from.fax

string | null

Fax number

Maximum length: 32

Example:

null

credits.invoice.ship_from.email

string | null

Contact email address

Maximum length: 128

Example:

null

credits.invoice.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

credits.invoice.sold_to

object

Show child attributes

credits.invoice.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

credits.invoice.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

credits.invoice.sold_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

credits.invoice.sold_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

credits.invoice.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

credits.invoice.sold_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

credits.invoice.sold_to.id

integer

Address ID

Example:

10

credits.invoice.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

credits.invoice.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

credits.invoice.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

credits.invoice.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

credits.invoice.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

credits.invoice.sold_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

credits.invoice.sold_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

credits.invoice.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

credits.invoice.ship_to

object

Show child attributes

credits.invoice.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

credits.invoice.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

credits.invoice.ship_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

credits.invoice.ship_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

credits.invoice.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

credits.invoice.ship_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

credits.invoice.ship_to.id

integer

Address ID

Example:

10

credits.invoice.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

credits.invoice.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

credits.invoice.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

Example:

null

credits.invoice.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

credits.invoice.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

credits.invoice.ship_to.fax

string | null

Fax number

Maximum length: 32

Example:

null

credits.invoice.ship_to.email

string | null

Contact email address

Maximum length: 128

Example:

null

credits.invoice.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

Example:

null

credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

Example:

"ALZ carrier"

credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

Example:

"230F"

credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

Example:

"SH879"

credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

Example:

"Next day delivery"

credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

Example:

"ND"

credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

Example:

"1Z9999999999999988"

credits.invoice.shipping_weight

string | null

Shipping weight

Example:

"7.00"

credits.invoice.notes

string | null

Addition info adding to shipping

Example:

"Signature required"

credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

Example:

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

credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

Example:

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

credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

Example:

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

credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

Example:

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

credits.invoice.paid_at

string | null

Time of payment (UTC format)

Example:

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

credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

Example:

null

credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

Example:

null

credits.invoice.allowances

object[]

Show child attributes

credits.invoice.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

Example:

"Sample-discount-allowance"

credits.invoice.allowances.price

string

required

Allowance price

Example:

"12.10"

credits.invoice.allowances.id

integer

Allowance ID

Example:

1

credits.invoice.allowances.adjustment_code

object

Show child attributes

credits.invoice.allowances.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

credits.invoice.allowances.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

credits.invoice.allowances.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

credits.invoice.allowances.adjustment_code.id

integer

Adjustment ID

Example:

1

credits.invoice.charges

object[]

Show child attributes

credits.invoice.charges.description

string

required

Invoice description

Required string length: 1 - 128

Example:

"Sample invoice and its description"

credits.invoice.charges.price

string

required

Invoice price

Example:

"23.45"

credits.invoice.charges.id

integer

Invoice ID

Example:

654

credits.invoice.charges.adjustment_code

object

Show child attributes

credits.invoice.charges.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

credits.invoice.charges.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

credits.invoice.charges.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

credits.invoice.charges.adjustment_code.id

integer

Adjustment ID

Example:

1

credits.invoice.invoice_lines

object[]

Show child attributes

credits.invoice.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 <= x <= 2147483647

Example:

45

credits.invoice.invoice_lines.price

string

required

Discounted price

Example:

"12.00"

credits.invoice.invoice_lines.id

integer

Invoice line ID

Example:

765

credits.invoice.invoice_lines.variant

object

Show child attributes

credits.invoice.invoice_lines.variant.id

integer

Variant ID

Example:

100024

credits.invoice.invoice_lines.variant.name

string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

credits.invoice.invoice_lines.variant.brand

object

Show child attributes

credits.invoice.invoice_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

credits.invoice.invoice_lines.variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

Example:

"5000001"

credits.invoice.invoice_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

credits.invoice.invoice_lines.variant.cartons

object[]

Show child attributes

credits.invoice.invoice_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

credits.invoice.invoice_lines.variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

Example:

"Print"

credits.invoice.invoice_lines.variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

Example:

"Large"

credits.invoice.invoice_lines.variant.media

object[]

Show child attributes

credits.invoice.invoice_lines.variant.attributes

object[]

Show child attributes

credits.invoice.invoice_lines.variant.ruleset_variants

object[]

Show child attributes

credits.invoice.invoice_lines.variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

Example:

"21"

credits.invoice.invoice_lines.variant.active_permit

object

Show child attributes

credits.invoice.invoice_lines.variant.permits

object[]

Show child attributes

credits.invoice.invoice_lines.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

Example:

true

credits.invoice.invoice_lines.variant.proposal_variant

object

Show child attributes

credits.invoice.invoice_lines.variant.retailer_identifiers

object

Show child attributes

credits.invoice.invoice_lines.variant.retailer_categories

object

Show child attributes

credits.invoice.invoice_lines.variant.inventory

object

Show child attributes

credits.invoice.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 <= x <= 2147483647

Example:

2

credits.invoice.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

Example:

"Vend134"

credits.invoice.invoice_lines.item_upc

string | null

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store

Maximum length: 32

Example:

"911911911112"

credits.invoice.invoice_lines.name

string | null

Product name

Maximum length: 128

Example:

"SamPro1"

credits.invoice.invoice_lines.description

string | null

Product description

Maximum length: 128

Example:

"Sample description of product"

credits.invoice.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

Example:

null

credits.invoice.invoice_lines.retail_price

string

Retail price

Example:

"14.00"

credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

Example:

"12.89"

credits.invoice.due_amount

string | null

Pending amount

Example:

"2.89"

credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

Example:

"2.89"

credits.invoice.subtotal

string | null

Sub-total

Example:

"10.89"

credits.invoice.tax

string | null

Total tax on the invoice

Example:

"2.00"

credits.invoice.invoice_acceptance

object

Show child attributes

credits.invoice.invoice_acceptance.id

integer

Invoice acceptance ID

Example:

565

credits.invoice.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

credits.invoice.invoice_acceptance.accepted_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

credits.invoice.invoice_acceptance.accepted_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

credits.invoice.invoice_acceptance.accepted_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

credits.invoice.invoice_acceptance.accepted_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

credits.invoice.invoice_acceptance.accepted_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

credits.invoice.invoice_acceptance.accepted_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

credits.invoice.invoice_acceptance.accepted_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

credits.invoice.invoice_acceptance.accepted_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

credits.invoice.invoice_acceptance.accepted_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

credits.invoice.invoice_acceptance.rejected_by

object

Show child attributes

credits.invoice.invoice_acceptance.rejected_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

credits.invoice.invoice_acceptance.rejected_by.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

credits.invoice.invoice_acceptance.rejected_by.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

credits.invoice.invoice_acceptance.rejected_by.title

string | null

User title

Maximum length: 64

Example:

"Demo"

credits.invoice.invoice_acceptance.rejected_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

credits.invoice.invoice_acceptance.rejected_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

credits.invoice.invoice_acceptance.rejected_by.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

credits.invoice.invoice_acceptance.rejected_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

credits.invoice.invoice_acceptance.rejected_by.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

credits.invoice.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

Example:

"Incorrect"

credits.invoice.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

Example:

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

credits.invoice.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

Example:

null

credits.order

string

Order details

credits.credit_number

string | null

Credit number

Maximum length: 32

Example:

"849238"

credits.credit_lines

object[]

Show child attributes

credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 <= x <= 2147483647

Example:

10

credits.credit_lines.id

integer

Credit line ID

Example:

566

credits.credit_lines.variant

object

Show child attributes

credits.credit_lines.variant.id

integer

Variant ID

Example:

100024

credits.credit_lines.variant.name

string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

credits.credit_lines.variant.brand

object

Show child attributes

credits.credit_lines.variant.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

credits.credit_lines.variant.brand.id

integer

Vendor (brand) ID

Example:

500

credits.credit_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

credits.credit_lines.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

credits.credit_lines.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

credits.credit_lines.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

credits.credit_lines.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

credits.credit_lines.variant.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

credits.credit_lines.variant.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

credits.credit_lines.variant.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

credits.credit_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

credits.credit_lines.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

credits.credit_lines.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

credits.credit_lines.variant.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

credits.credit_lines.variant.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

credits.credit_lines.variant.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

credits.credit_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

credits.credit_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

credits.credit_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

credits.credit_lines.variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

Example:

"5000001"

credits.credit_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

credits.credit_lines.variant.cartons

object[]

Show child attributes

credits.credit_lines.variant.cartons.id

integer

Carton ID

Example:

48

credits.credit_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

credits.credit_lines.variant.cartons.length

string | null

Carton length

Example:

"1"

credits.credit_lines.variant.cartons.length_unit

string

Unit of length

Example:

"1"

credits.credit_lines.variant.cartons.width

string | null

Carton width

Example:

"1"

credits.credit_lines.variant.cartons.width_unit

string

Unit of width

Example:

"meter"

credits.credit_lines.variant.cartons.height

string | null

Carton height

Example:

"1"

credits.credit_lines.variant.cartons.height_unit

string

Unit of height

Example:

"meter"

credits.credit_lines.variant.cartons.weight

string | null

Carton weight

Example:

"15"

credits.credit_lines.variant.cartons.weight_unit

string

Unit of weight

Example:

"KG"

credits.credit_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

Example:

"1"

credits.credit_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

Example:

"1"

credits.credit_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

credits.credit_lines.variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

Example:

"Print"

credits.credit_lines.variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

Example:

"Large"

credits.credit_lines.variant.media

object[]

Show child attributes

credits.credit_lines.variant.media.id

integer

Variant ID

Example:

249

credits.credit_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

credits.credit_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

credits.credit_lines.variant.media.media

string

Variant images

Example:

"default"

credits.credit_lines.variant.media.priority

integer

Order in which the vendor prefers the images to be shown image 1 is shown first.

Required range: -2147483648 <= x <= 2147483647

Example:

1

credits.credit_lines.variant.media.url

string

URL of variant image

Example:

"192.168.99.100/media/default/original"

credits.credit_lines.variant.media.updated_at

string

Time of variant image update (UTC format)

Example:

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

credits.credit_lines.variant.media.created_at

string

Time of variant image creation (UTC format)

Example:

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

credits.credit_lines.variant.attributes

object[]

Show child attributes

credits.credit_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"size"

credits.credit_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Size"

credits.credit_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

credits.credit_lines.variant.attributes.id

integer

Attribute ID

Example:

44

credits.credit_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

credits.credit_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"general"

credits.credit_lines.variant.attributes.description

string | null

Attribute description

Example:

"demo product description"

credits.credit_lines.variant.attributes.units

string | null

Unit of the selected attribute type. If the attribute type is money, the unit is USD.

Maximum length: 32

Example:

"USD"

credits.credit_lines.variant.attributes.values

object

Show child attributes

credits.credit_lines.variant.ruleset_variants

object[]

Show child attributes

credits.credit_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

Example:

1232

credits.credit_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

credits.credit_lines.variant.ruleset_variants.ruleset

object

Show child attributes

credits.credit_lines.variant.ruleset_variants.results

string

Response

credits.credit_lines.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

Example:

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

credits.credit_lines.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

Example:

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

credits.credit_lines.variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

Example:

"21"

credits.credit_lines.variant.active_permit

object

Show child attributes

credits.credit_lines.variant.active_permit.id

integer

Permit ID

Example:

10104

credits.credit_lines.variant.active_permit.retailer

object

Show child attributes

credits.credit_lines.variant.active_permit.retailer_price

string | null

Retailer price of the variant

Example:

"12.99"

credits.credit_lines.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

Example:

"8.99"

credits.credit_lines.variant.active_permit.pricing

object

credits.credit_lines.variant.active_permit.attributes

object

credits.credit_lines.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

Example:

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

credits.credit_lines.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

Example:

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

credits.credit_lines.variant.active_permit.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

Example:

true

credits.credit_lines.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

Example:

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

credits.credit_lines.variant.active_permit.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

Example:

true

credits.credit_lines.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

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

credits.credit_lines.variant.permits

object[]

Show child attributes

credits.credit_lines.variant.permits.id

integer

Permit ID

Example:

10104

credits.credit_lines.variant.permits.retailer

object

Show child attributes

credits.credit_lines.variant.permits.retailer_price

string | null

Retailer price of the variant

Example:

"12.99"

credits.credit_lines.variant.permits.retailer_cost

string | null

Retailer cost of variant

Example:

"8.99"

credits.credit_lines.variant.permits.pricing

object

credits.credit_lines.variant.permits.attributes

object

credits.credit_lines.variant.permits.start_at

string | null

Time of permit start (UTC format)

Example:

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

credits.credit_lines.variant.permits.end_at

string | null

Time of permit end (UTC format)

Example:

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

credits.credit_lines.variant.permits.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

Example:

true

credits.credit_lines.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

Example:

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

credits.credit_lines.variant.permits.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

Example:

true

credits.credit_lines.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

Example:

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

credits.credit_lines.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

Example:

true

credits.credit_lines.variant.proposal_variant

object

Show child attributes

credits.credit_lines.variant.proposal_variant.id

integer

Proposal variant ID

Example:

3456

credits.credit_lines.variant.proposal_variant.pricing

string

Pricing of variant

Example:

"12.00"

credits.credit_lines.variant.proposal_variant.attributes

object[]

Show child attributes

credits.credit_lines.variant.proposal_variant.memos

object[]

Show child attributes

credits.credit_lines.variant.proposal_variant.issues

object[]

Show child attributes

credits.credit_lines.variant.proposal_variant.variant_id

integer

Variant ID

Example:

249

credits.credit_lines.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

Example:

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

credits.credit_lines.variant.proposal_variant.created_at

string

Time of creation (UTC format)

Example:

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

credits.credit_lines.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

Example:

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

credits.credit_lines.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

Example:

null

credits.credit_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

Example:

"Incomplete"

credits.credit_lines.variant.proposal_variant.reject

boolean

true: proposal is rejected <br /> false: proposal is not rejected

Example:

true

credits.credit_lines.variant.proposal_variant.approve

boolean

true: proposal is approved <br /> false: proposal is not approved

Example:

false

credits.credit_lines.variant.proposal_variant.delete

boolean

true: proposal is deleted <br /> false: proposal is not deleted

Example:

false

credits.credit_lines.variant.retailer_identifiers

object

Show child attributes

credits.credit_lines.variant.retailer_identifiers.id

integer

Retailer ID

Example:

5642

credits.credit_lines.variant.retailer_identifiers.retailer

object

Show child attributes

credits.credit_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

Example:

"SKU976"

credits.credit_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

Example:

"Retailer Sample"

credits.credit_lines.variant.retailer_categories

object

Show child attributes

credits.credit_lines.variant.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

credits.credit_lines.variant.retailer_categories.id

integer

Retailer category ID

Example:

453

credits.credit_lines.variant.retailer_categories.retailer

object

Show child attributes

credits.credit_lines.variant.inventory

object

Show child attributes

credits.credit_lines.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

Example:

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

credits.credit_lines.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

Example:

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

credits.credit_lines.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

Example:

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

credits.credit_lines.variant.inventory.sellable_updated_at

string

required

Time when product or variant was marked sellable (UTC format)

Example:

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

credits.credit_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

Example:

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

credits.credit_lines.variant.inventory.discontinued

boolean

true: Product is discontinued <br /> false: Product is active

Example:

true

credits.credit_lines.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

Example:

null

credits.credit_lines.variant.inventory.inventory

integer

Inventory of variant

Example:

0

credits.credit_lines.variant.inventory.sellable

string

yes: Variant is sellable <br /> No: Variant is not sellable

Example:

"No"

credits.credit_lines.variant.inventory.replenishable

boolean

true: product is replenishable <br /> false: product is not replenishable

Example:

true

credits.credit_lines.variant.inventory.locations

object[]

Show child attributes

credits.credit_lines.net_price

string

Credit line net price

Example:

"12.99"

credits.adjustments

object[]

Show child attributes

credits.adjustments.id

integer

Adjustment ID

Example:

566

credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

Example:

"Sample description for adjustment"

credits.adjustments.net_price

string

Adjustment net price

Example:

"1.00"

credits.acknowledged_at

string | null

Time of credit acknowledgement

Example:

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

credits.credited_at

string | null

Time of credit (UTC format)

Example:

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

credits.created_at

string

Time of creation (UTC format)

Example:

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

credits.subtotal

string

Subtotal amount

Example:

"20.00"

credits.credit_amount

string

Credit amount

Example:

"24.00"

order_batches

object[]

Show child attributes

order_batches.id

integer

Batch ID of order

Example:

2456

metadata

object[]

Show child attributes

metadata.id

integer

Metadata ID

Example:

456

metadata.name

string

Metadata name

Minimum length: 1

Example:

"MD143"

metadata.value

string | null

Metadata value, depending on the type

Example:

"12"

metadata.type

string

Metadata type such as integer, float, etc.

Minimum length: 1

Example:

"string"

metadata.created_at

string

Time of metadata creation (UTC format)

Example:

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

connection_shipping_provider_account

object

Show child attributes

connection_shipping_provider_account.id

integer

Shipping carrier account ID

Example:

123

connection_shipping_provider_account.connection

object

Show child attributes

connection_shipping_provider_account.connection.id

integer

Connection ID

Example:

"1001"

connection_shipping_provider_account.connection.brand

object

Show child attributes

connection_shipping_provider_account.connection.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

connection_shipping_provider_account.connection.brand.id

integer

Vendor (brand) ID

Example:

500

connection_shipping_provider_account.connection.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

connection_shipping_provider_account.connection.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

connection_shipping_provider_account.connection.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

connection_shipping_provider_account.connection.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

connection_shipping_provider_account.connection.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

connection_shipping_provider_account.connection.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

connection_shipping_provider_account.connection.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

connection_shipping_provider_account.connection.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

connection_shipping_provider_account.connection.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

connection_shipping_provider_account.connection.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

connection_shipping_provider_account.connection.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

connection_shipping_provider_account.connection.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

connection_shipping_provider_account.connection.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

connection_shipping_provider_account.connection.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

connection_shipping_provider_account.connection.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

connection_shipping_provider_account.connection.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

connection_shipping_provider_account.connection.retailer

object

Show child attributes

connection_shipping_provider_account.connection.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

connection_shipping_provider_account.connection.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

connection_shipping_provider_account.connection.retailer.id

integer

Retailer ID

Example:

500

connection_shipping_provider_account.connection.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

connection_shipping_provider_account.connection.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

connection_shipping_provider_account.connection.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

connection_shipping_provider_account.connection.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

connection_shipping_provider_account.connection.retailer.is_rcn_retailer

boolean

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

Example:

false

connection_shipping_provider_account.connection.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

connection_shipping_provider_account.connection.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

connection_shipping_provider_account.connection.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

connection_shipping_provider_account.connection.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

connection_shipping_provider_account.connection.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

connection_shipping_provider_account.connection.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

connection_shipping_provider_account.connection.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

Example:

"active"

connection_shipping_provider_account.connection.created_at

string

Time of connection creation

Example:

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

connection_shipping_provider_account.connection.level

enum<string>

Connection type

Available options:

basic,

full

Example:

"full"

connection_shipping_provider_account.connection.options

object

Show child attributes

connection_shipping_provider_account.connection.options.name

string

required

Option name

Required string length: 1 - 64

Example:

"Sample Option"

connection_shipping_provider_account.connection.options.code

string

required

Option code

Required string length: 1 - 64

Example:

"Sample_Option"

connection_shipping_provider_account.connection.options.id

integer

Option ID

Example:

8753

connection_shipping_provider_account.connection.options.description

string | null

Connection description

Example:

"Sample description for connection"

connection_shipping_provider_account.connection.options.viewable_by

enum<string> | null

User who can view the connection details

Available options:

retailer,

brand,

all,

none

Example:

"All"

connection_shipping_provider_account.connection.options.editable_by

enum<string> | null

User who can edit connection

Available options:

retailer,

brand,

staff

Example:

"Staff"

connection_shipping_provider_account.connection.metadata

string

Metadata

Example:

"About us"

connection_shipping_provider_account.connection.connection_adjustments

object[]

Show child attributes

connection_shipping_provider_account.connection.connection_adjustments.description

string

required

Description of adjustment

Required string length: 1 - 256

Example:

"Sample description for monetary adjustments"

connection_shipping_provider_account.connection.connection_adjustments.id

integer

Connection adjustment ID, used for monetary adjustments

Example:

123442

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code

object

Show child attributes

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code.id

integer

Adjustment ID

Example:

1

connection_shipping_provider_account.connection.connection_adjustments.adjustment_type

string

Adjustment type

Example:

"Discount"

connection_shipping_provider_account.connection.connection_adjustments.adjustment_amount_type

enum<string>

Adjustment type - dollar amount or percentage

Available options:

percent,

flat

Example:

"flat"

connection_shipping_provider_account.connection.connection_adjustments.adjustment_amount

string

Adjustment amount

Example:

"12"

connection_shipping_provider_account.connection.connection_adjustments.content_type

string

Content type

Minimum length: 1

Example:

"PDF"

connection_shipping_provider_account.connection.connection_adjustments.object_id

integer | null

Object ID

Required range: 0 <= x <= 4294967295

Example:

45646

connection_shipping_provider_account.connection.integration_type

enum<string> | null

Integration type

Available options:

console,

edi,

api,

storefront,

console-print-labels,

console-register-tracking-numbers,

shopify,

bigcommerce,

shipstation

Example:

"API"

connection_shipping_provider_account.connection.retailer_identifier

string | null

Variant identifier specific to retailer

Maximum length: 32

Example:

"R566A"

connection_shipping_provider_account.shipping_provider_account

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.id

integer

Account ID of shipping provider

Example:

76546

connection_shipping_provider_account.shipping_provider_account.shipping_provider

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_provider.id

integer

Shipping provider ID

Example:

2455

connection_shipping_provider_account.shipping_provider_account.shipping_provider.name

string | null

Name of shipping provider

Maximum length: 32

Example:

"Sample shipping provider"

connection_shipping_provider_account.shipping_provider_account.shipping_provider.credentials

string

Credentials for shipping provider

connection_shipping_provider_account.shipping_provider_account.shipping_provider.shipping_methods

string

Shipping methods

Example:

"Next day delivery"

connection_shipping_provider_account.shipping_provider_account.shipping_provider.created_at

string

Time of shipping provider creation (UTC format)

Example:

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

connection_shipping_provider_account.shipping_provider_account.shipping_provider.updated_at

string

Time of shipping provider update (UTC format)

Example:

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

connection_shipping_provider_account.shipping_provider_account.shipping_methods

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

Example:

"White Glove Bronze"

connection_shipping_provider_account.shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

Example:

"cory_white_glove"

connection_shipping_provider_account.shipping_provider_account.shipping_methods.id

integer

ID of shipping method

Example:

5

connection_shipping_provider_account.shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl (less than truck load)"

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.id

integer

Carrier ID

Example:

229

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.id

integer

ID of shipping method

Example:

5

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl"

connection_shipping_provider_account.shipping_provider_account.credential_values

object[]

Show child attributes

connection_shipping_provider_account.shipping_provider_account.credential_values.id

integer

Credentials ID

Example:

165

connection_shipping_provider_account.shipping_provider_account.credential_values.credential

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.code

string

required

Credentials code

Required string length: 1 - 64

Example:

"cred_sample"

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.name

string

required

Credentials code

Required string length: 1 - 64

Example:

"Cred Sample"

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.data_type

enum<string>

required

Data type of credentials

Available options:

text,

boolean

Example:

"text"

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.id

integer

Credentials ID

Example:

656

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.is_required

integer

1: Credentials are required <br /> 0: Credentials are not required

Required range: -2147483648 <= x <= 2147483647

Example:

1

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.is_encrypted

integer

1: Credentials are encrypted <br /> 0: Credentials are not encrypted

Required range: -2147483648 <= x <= 2147483647

Example:

1

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.created_at

string

Time of credentials creation (UTC format)

Example:

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

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.updated_at

string

Time of credentials update (UTC format)

Example:

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

connection_shipping_provider_account.shipping_provider_account.credential_values.value

string

Credentials value

connection_shipping_provider_account.shipping_provider_account.credential_values.created_at

string

Time of credentials creation (UTC format)

Example:

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

connection_shipping_provider_account.shipping_provider_account.credential_values.updated_at

string

Time of credentials update (UTC format)

Example:

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

connection_shipping_provider_account.shipping_provider_account.created_at

string

Time of account (UTC format)

Example:

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

connection_shipping_provider_account.shipping_provider_account.updated_at

string

Time of account update (UTC format)

Example:

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

connection_shipping_provider_account.shipping_methods

object

Show child attributes

connection_shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

Example:

"White Glove Bronze"

connection_shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

Example:

"cory_white_glove"

connection_shipping_provider_account.shipping_methods.id

integer

ID of shipping method

Example:

5

connection_shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl (less than truck load)"

connection_shipping_provider_account.shipping_methods.carrier

object

Show child attributes

connection_shipping_provider_account.shipping_methods.carrier.id

integer

Carrier ID

Example:

229

connection_shipping_provider_account.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

connection_shipping_provider_account.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

connection_shipping_provider_account.shipping_methods.generic_shipping_method

object

Show child attributes

connection_shipping_provider_account.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

connection_shipping_provider_account.shipping_methods.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

connection_shipping_provider_account.shipping_methods.generic_shipping_method.id

integer

ID of shipping method

Example:

5

connection_shipping_provider_account.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl"

connection_shipping_provider_account.created_at

string

Time of creation (UTC format)

Example:

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

connection_shipping_provider_account.updated_at

string

Time of last update (UTC format)

Example:

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

is_priority

boolean

true: Priority order <br /> false: Not a priority order

Example:

false

priority_user

object

Show child attributes

priority_user.id

integer

User ID who accepted or rejected the invoice

Example:

542

priority_user.first_name

string | null

First name of user

Maximum length: 64

Example:

"Sample"

priority_user.last_name

string | null

Last name of user

Maximum length: 64

Example:

"Demo"

priority_user.title

string | null

User title

Maximum length: 64

Example:

"Demo"

priority_user.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

priority_user.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

priority_user.photo_url

string

URL of the user photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

priority_user.profile_photo

string

URL of the user's profile photo

Minimum length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

priority_user.is_me

boolean

true: user is me: <br /> false: user is not me

Example:

true

envelopes

object[]

Show child attributes

envelopes.interchange_control_number

integer

required

Interchange control number

Required range: 0 <= x <= 4294967295

Example:

2545

envelopes.data_interchange_control_number

integer

required

Data interchange control number

Required range: 0 <= x <= 4294967295

Example:

12455

envelopes.direction

enum<string>

required

Direction of envelop

Available options:

incoming,

outgoing

Example:

"incoming"

envelopes.functional_identifier

enum<string>

required

Functional identifier

Available options:

PO,

IN,

SH,

IB,

FA,

PR,

PC

Example:

"PO"

envelopes.id

integer

Envelop ID

Example:

663

envelopes.sender

object

Show child attributes

envelopes.sender.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

Example:

"SKU1"

envelopes.sender.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

Example:

"ACF1"

envelopes.sender.id

integer

EDI account ID

Example:

2344

envelopes.sender.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

Example:

"active"

envelopes.sender.retailer

object

Show child attributes

envelopes.sender.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

envelopes.sender.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

envelopes.sender.retailer.id

integer

Retailer ID

Example:

500

envelopes.sender.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

envelopes.sender.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

envelopes.sender.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

envelopes.sender.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

envelopes.sender.retailer.is_rcn_retailer

boolean

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

Example:

false

envelopes.sender.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

envelopes.sender.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

envelopes.sender.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

envelopes.sender.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

envelopes.sender.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

envelopes.sender.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

envelopes.sender.brand

object

Show child attributes

envelopes.sender.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

envelopes.sender.brand.id

integer

Vendor (brand) ID

Example:

500

envelopes.sender.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

envelopes.sender.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

envelopes.sender.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

envelopes.sender.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

envelopes.sender.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

envelopes.sender.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

envelopes.sender.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

envelopes.sender.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

envelopes.sender.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

envelopes.sender.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

envelopes.sender.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

envelopes.sender.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

envelopes.sender.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

envelopes.sender.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

envelopes.sender.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

envelopes.sender.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

envelopes.sender.qualifier

enum<string>

default:ZZ

Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier

Available options:

ZZ,

01,

02,

08,

09,

12,

13,

14,

15,

16

Example:

"01"

envelopes.receiver

object

Show child attributes

envelopes.receiver.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

Example:

"SKU1"

envelopes.receiver.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

Example:

"ACF1"

envelopes.receiver.id

integer

EDI account ID

Example:

2344

envelopes.receiver.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

Example:

"active"

envelopes.receiver.retailer

object

Show child attributes

envelopes.receiver.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

envelopes.receiver.retailer.code

string

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

envelopes.receiver.retailer.id

integer

Retailer ID

Example:

500

envelopes.receiver.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

Example:

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

envelopes.receiver.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

Example:

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

envelopes.receiver.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

Example:

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

envelopes.receiver.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

Example:

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

envelopes.receiver.retailer.is_rcn_retailer

boolean

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

Example:

false

envelopes.receiver.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

Example:

false

envelopes.receiver.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

envelopes.receiver.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

envelopes.receiver.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

Example:

false

envelopes.receiver.retailer.website

string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

envelopes.receiver.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

envelopes.receiver.brand

object

Show child attributes

envelopes.receiver.brand.code

string

required

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

Required string length: 1 - 64

Example:

"demo-brand"

envelopes.receiver.brand.id

integer

Vendor (brand) ID

Example:

500

envelopes.receiver.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

envelopes.receiver.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

Example:

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

envelopes.receiver.brand.logo_url

string

URL of the brand logo

Minimum length: 1

Example:

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

envelopes.receiver.brand.cover_url

string

URL of the cover image

Minimum length: 1

Example:

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

envelopes.receiver.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

Example:

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

envelopes.receiver.brand.website

string | null

URL of brand website

Maximum length: 100

Example:

null

envelopes.receiver.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

Example:

false

envelopes.receiver.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

Example:

false

envelopes.receiver.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

envelopes.receiver.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

Example:

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

envelopes.receiver.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

Example:

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

envelopes.receiver.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

Example:

false

envelopes.receiver.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

Example:

false

envelopes.receiver.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

Example:

false

envelopes.receiver.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

envelopes.receiver.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

envelopes.receiver.qualifier

enum<string>

default:ZZ

Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier

Available options:

ZZ,

01,

02,

08,

09,

12,

13,

14,

15,

16

Example:

"01"

envelopes.edi

string

Electronic data exchange (EDI)

envelopes.request_acknowledgment

boolean

true: Request is acknowledged <br /> false: Request is not acknowledged.

Example:

true

envelopes.sub_element_delimiter

string

Sub element delimiter

Required string length: 1 - 12

envelopes.segment_delimiter

string

Segment delimited

Required string length: 1 - 12

Example:

"demo12"

envelopes.element_delimiter

string

Element delimiter

Required string length: 1 - 12

envelopes.accepted_at

string | null

Time of envelope acceptance (UTC format)

Example:

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

envelopes.created_at

string

Time of envelope creation (UTC format)

Example:

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

envelopes.rejected_at

string | null

Time of envelope rejection (UTC format)

Example:

null

envelopes.transmitted_at

string | null

Time of envelope transmittance (UTC format)

Example:

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

envelopes.documents

object[]

Show child attributes

envelopes.documents.transaction_set

enum<string>

required

Transaction set

Available options:

810,

846,

850,

855,

856,

860,

997

Example:

"810"

envelopes.documents.transaction_set_control_number

integer

required

Transaction set control number related to EDI

Required range: 0 <= x <= 4294967295

Example:

456

envelopes.documents.id

integer

Document ID

Example:

254

envelopes.documents.jobs

object[]

Show child attributes

envelopes.documents.jobs.content_type

integer

required

Content type

Example:

1

envelopes.documents.jobs.object_id

integer

required

Object ID

Required range: 0 <= x <= 4294967295

Example:

145

envelopes.documents.jobs.runtime_id

string

required

Runtime ID

Required string length: 1 - 64

envelopes.documents.jobs.module_name

string

required

Module name

Required string length: 1 - 64

Example:

"demo module"

envelopes.documents.jobs.id

integer

Job ID

envelopes.documents.jobs.connection

object

Show child attributes

envelopes.documents.jobs.connection.id

integer

Connection ID

Example:

"1001"

envelopes.documents.jobs.connection.brand

object

Show child attributes

envelopes.documents.jobs.connection.retailer

object

Show child attributes

envelopes.documents.jobs.connection.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

Example:

"active"

envelopes.documents.jobs.connection.created_at

string

Time of connection creation

Example:

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

envelopes.documents.jobs.connection.level

enum<string>

Connection type

Available options:

basic,

full

Example:

"full"

envelopes.documents.jobs.connection.options

object

Show child attributes

envelopes.documents.jobs.connection.metadata

string

Metadata

Example:

"About us"

envelopes.documents.jobs.connection.connection_adjustments

object[]

Show child attributes

envelopes.documents.jobs.connection.integration_type

enum<string> | null

Integration type

Available options:

console,

edi,

api,

storefront,

console-print-labels,

console-register-tracking-numbers,

shopify,

bigcommerce,

shipstation

Example:

"API"

envelopes.documents.jobs.connection.retailer_identifier

string | null

Variant identifier specific to retailer

Maximum length: 32

Example:

"R566A"

envelopes.documents.jobs.created_at

string

Time of job creation (UTC format)

Example:

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

envelopes.documents.jobs.start_time

string

Time of job beginning (UTC format)

Example:

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

envelopes.documents.jobs.finish_time

string

Time of job ending (UTC format)

Example:

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

envelopes.documents.jobs.description

string

Bried description of job, for future reference

envelopes.documents.jobs.total_success

string

Successful completion of job

envelopes.documents.jobs.total_failure

string

Unsuccessful completion of job

envelopes.documents.jobs.metadata

object[]

envelopes.documents.jobs.error_count

string

Error count

envelopes.documents.jobs.error_logs

object

Show child attributes

envelopes.documents.jobs.error_logs.id

integer

Error log ID

Example:

677

envelopes.documents.jobs.error_logs.message

string | null

Message in error log

Example:

"Sample errors to fix"

envelopes.documents.jobs.error_logs.count

integer

Count of error log

Example:

12

envelopes.documents.jobs.error_logs.created_at

string

Time of error log creation

Example:

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

envelopes.documents.accepted_at

string | null

Time of document acceptance (UTC format)

Example:

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

envelopes.documents.rejected_at

string | null

Time of document rejection (UTC format)

Example:

null

envelopes.entities

object[]

Show child attributes

envelopes.entities.envelope

object

required

Show child attributes

envelopes.entities.envelope.interchange_control_number

integer

required

Interchange control number

Required range: 0 <= x <= 4294967295

Example:

2545

envelopes.entities.envelope.data_interchange_control_number

integer

required

Data interchange control number

Required range: 0 <= x <= 4294967295

Example:

12455

envelopes.entities.envelope.direction

enum<string>

required

Direction of envelop

Available options:

incoming,

outgoing

Example:

"incoming"

envelopes.entities.envelope.functional_identifier

enum<string>

required

Functional identifier

Available options:

PO,

IN,

SH,

IB,

FA,

PR,

PC

Example:

"PO"

envelopes.entities.envelope.id

integer

Envelop ID

Example:

663

envelopes.entities.envelope.sender

object

Show child attributes

envelopes.entities.envelope.sender.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

Example:

"SKU1"

envelopes.entities.envelope.sender.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

Example:

"ACF1"

envelopes.entities.envelope.sender.id

integer

EDI account ID

Example:

2344

envelopes.entities.envelope.sender.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

Example:

"active"

envelopes.entities.envelope.sender.retailer

object

Show child attributes

envelopes.entities.envelope.sender.brand

object

Show child attributes

envelopes.entities.envelope.sender.qualifier

enum<string>

default:ZZ

Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier

Available options:

ZZ,

01,

02,

08,

09,

12,

13,

14,

15,

16

Example:

"01"

envelopes.entities.envelope.receiver

object

Show child attributes

envelopes.entities.envelope.receiver.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

Example:

"SKU1"

envelopes.entities.envelope.receiver.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

Example:

"ACF1"

envelopes.entities.envelope.receiver.id

integer

EDI account ID

Example:

2344

envelopes.entities.envelope.receiver.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

Example:

"active"

envelopes.entities.envelope.receiver.retailer

object

Show child attributes

envelopes.entities.envelope.receiver.brand

object

Show child attributes

envelopes.entities.envelope.receiver.qualifier

enum<string>

default:ZZ

Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier

Available options:

ZZ,

01,

02,

08,

09,

12,

13,

14,

15,

16

Example:

"01"

envelopes.entities.envelope.edi

string

Electronic data exchange (EDI)

envelopes.entities.envelope.request_acknowledgment

boolean

true: Request is acknowledged <br /> false: Request is not acknowledged.

Example:

true

envelopes.entities.envelope.sub_element_delimiter

string

Sub element delimiter

Required string length: 1 - 12

envelopes.entities.envelope.segment_delimiter

string

Segment delimited

Required string length: 1 - 12

Example:

"demo12"

envelopes.entities.envelope.element_delimiter

string

Element delimiter

Required string length: 1 - 12

envelopes.entities.envelope.accepted_at

string | null

Time of envelope acceptance (UTC format)

Example:

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

envelopes.entities.envelope.created_at

string

Time of envelope creation (UTC format)

Example:

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

envelopes.entities.envelope.rejected_at

string | null

Time of envelope rejection (UTC format)

Example:

null

envelopes.entities.envelope.transmitted_at

string | null

Time of envelope transmittance (UTC format)

Example:

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

envelopes.entities.envelope.documents

object[]

Show child attributes

envelopes.entities.envelope.documents.transaction_set

enum<string>

required

Transaction set

Available options:

810,

846,

850,

855,

856,

860,

997

Example:

"810"

envelopes.entities.envelope.documents.transaction_set_control_number

integer

required

Transaction set control number related to EDI

Required range: 0 <= x <= 4294967295

Example:

456

envelopes.entities.envelope.documents.id

integer

Document ID

Example:

254

envelopes.entities.envelope.documents.jobs

object[]

Show child attributes

envelopes.entities.envelope.documents.accepted_at

string | null

Time of document acceptance (UTC format)

Example:

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

envelopes.entities.envelope.documents.rejected_at

string | null

Time of document rejection (UTC format)

Example:

null

envelopes.entities.envelope.entities

object[]

Show child attributes

envelopes.entities.envelope.entities.envelope

object

required

Show child attributes

envelopes.entities.envelope.entities.content_type

integer

required

Content type

Example:

"PDF"

envelopes.entities.envelope.entities.object_id

integer

required

Object ID associated with the content type

Required range: 0 <= x <= 4294967295

Example:

666

envelopes.entities.envelope.entities.id

integer

Envelop entity ID

Example:

2145

envelopes.entities.content_type

integer

required

Content type

Example:

"PDF"

envelopes.entities.object_id

integer

required

Object ID associated with the content type

Required range: 0 <= x <= 4294967295

Example:

666

envelopes.entities.id

integer

Envelop entity ID

Example:

2145