Create a new order (mixed vendors)

Creates a new order (mixed vendors)

Authorizations

Authorization

string

header

required

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

Path Parameters

retailer_pk

number

required

Retailer ID

Body

application/json

ordered_at

string

required

Time of order finalization (UTC format)

purchase_order_number

string

required

Purchase order number

Minimum length: 1

acknowledged_at

string | null

Time of order acknowledgement (UTC format)

allow_shipping_label_generation

boolean

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

backorder_acknowledged_at

string | null

Time of backorder acknowledgement (UTC format)

backordered_until

string | null

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

bill_to

object

Show child attributes

bill_to.city

string

required

City name

Required string length: 1 - 64

bill_to.country

string

required

Country name

Required string length: 1 - 128

bill_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

bill_to.postal_code

string

required

Postal code

Required string length: 1 - 32

bill_to.province

string

required

State name

Required string length: 1 - 32

bill_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

bill_to.email

string | null

Contact email address

Maximum length: 128

bill_to.fax

string | null

Fax number

Maximum length: 32

bill_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

bill_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

bill_to.phone1

string | null

Primary contact number

Maximum length: 32

bill_to.phone2

string | null

Alternate contact number

Maximum length: 32

bill_to.street2

string | null

Line 2 of the address

Maximum length: 128

bill_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

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

brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

brand.is_on_rcn

boolean

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

brand.name

string

Vendor name

Required string length: 1 - 64

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

brand.website

string | null

URL of brand website

Maximum length: 100

brand_identifier

string | null

Vendor identifier

Maximum length: 64

canceled_at

string | null

Time of order cancellation (UTC format)

connection_id

integer

A numeric connection ID

connection_shipping_provider_account

object

Show child attributes

connection_shipping_provider_account.connection

object

Show child attributes

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

connection_shipping_provider_account.connection.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

connection_shipping_provider_account.connection.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

connection_shipping_provider_account.connection.brand.is_on_rcn

boolean

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

connection_shipping_provider_account.connection.brand.name

string

Vendor name

Required string length: 1 - 64

connection_shipping_provider_account.connection.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

connection_shipping_provider_account.connection.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

connection_shipping_provider_account.connection.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

connection_shipping_provider_account.connection.brand.website

string | null

URL of brand website

Maximum length: 100

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

connection_shipping_provider_account.connection.level

enum<string>

Connection type

Available options:

basic,

full

connection_shipping_provider_account.connection.options

object

Show child attributes

connection_shipping_provider_account.connection.options.code

string

required

Option code

Required string length: 1 - 64

connection_shipping_provider_account.connection.options.name

string

required

Option name

Required string length: 1 - 64

connection_shipping_provider_account.connection.options.description

string | null

Connection description

connection_shipping_provider_account.connection.options.editable_by

enum<string> | null

User who can edit connection

Available options:

retailer,

brand,

staff

connection_shipping_provider_account.connection.options.viewable_by

enum<string> | null

User who can view the connection details

Available options:

retailer,

brand,

all,

none

connection_shipping_provider_account.connection.retailer

object

Show child attributes

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

connection_shipping_provider_account.connection.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

connection_shipping_provider_account.connection.retailer.is_onboarded

boolean

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

connection_shipping_provider_account.connection.retailer.is_rcn_retailer

boolean

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

connection_shipping_provider_account.connection.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

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

connection_shipping_provider_account.connection.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

connection_shipping_provider_account.connection.retailer.website

string | null

Website URL

Maximum length: 100

connection_shipping_provider_account.connection.retailer_identifier

string | null

Variant identifier specific to retailer

Maximum length: 32

connection_shipping_provider_account.connection.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

connection_shipping_provider_account.shipping_methods

object

Show child attributes

connection_shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.carrier

object

Show child attributes

connection_shipping_provider_account.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.generic_shipping_method

object

Show child attributes

connection_shipping_provider_account.shipping_methods.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

connection_shipping_provider_account.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

connection_shipping_provider_account.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_provider_account

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

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

string

required

Description of shipping method

Required string length: 1 - 128

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_provider_account.shipping_provider

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_provider.name

string | null

Name of shipping provider

Maximum length: 32

currency

object

Show child attributes

currency.name

string

Currency name

Maximum length: 200

currency.symbol

string | null

Currency symbol

Maximum length: 5

customer_order_number

string | null

Customer order number

Maximum length: 64

fill_time

string | null

Fill time

fulfilled_at

string | null

Time of order fulfillment (UTC format)

gift_fee

string | null

Gift fee (if applicable)

is_gift

boolean

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

is_priority

boolean

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

is_replacement

boolean

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

on_hold_at

string | null

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

on_hold_until

string | null

Date till when the order will be on hold

pickup_on

string | null

Time of when order was picked up (UTC format)

priority_user

object

Show child attributes

priority_user.first_name

string | null

First name of user

Maximum length: 64

priority_user.last_name

string | null

Last name of user

Maximum length: 64

priority_user.status

enum<string>

User status

Available options:

active,

invited,

locked

priority_user.title

string | null

User title

Maximum length: 64

priority_user.type

enum<string>

User type

Available options:

standard,

api

requested_shipping_method

object

Show child attributes

requested_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

requested_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

requested_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

requested_shipping_method_id

integer

ID of the requested shipping method

retailer

object

Show child attributes

retailer.code

string

required

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

Required string length: 1 - 32

retailer.name

string

required

Retailer name

Required string length: 1 - 64

retailer.brand_permit_creation_allowed

boolean

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

retailer.is_onboarded

boolean

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

retailer.is_rcn_retailer

boolean

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

retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

retailer.website

string | null

Website URL

Maximum length: 100

retailer_order_number

string

Retailer order number

Minimum length: 1

return_to

object

Show child attributes

return_to.city

string

required

City name

Required string length: 1 - 64

return_to.country

string

required

Country name

Required string length: 1 - 128

return_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

return_to.postal_code

string

required

Postal code

Required string length: 1 - 32

return_to.province

string

required

State name

Required string length: 1 - 32

return_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

return_to.email

string | null

Contact email address

Maximum length: 128

return_to.fax

string | null

Fax number

Maximum length: 32

return_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

return_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

return_to.phone1

string | null

Primary contact number

Maximum length: 32

return_to.phone2

string | null

Alternate contact number

Maximum length: 32

return_to.street2

string | null

Line 2 of the address

Maximum length: 128

return_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

ship_from

object

Show child attributes

ship_from.city

string

required

City name

Required string length: 1 - 64

ship_from.country

string

required

Country name

Required string length: 1 - 128

ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

ship_from.province

string

required

State name

Required string length: 1 - 32

ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

ship_from.email

string | null

Contact email address

Maximum length: 128

ship_from.fax

string | null

Fax number

Maximum length: 32

ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

ship_from.phone1

string | null

Primary contact number

Maximum length: 32

ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

ship_to

object

Show child attributes

ship_to.city

string

required

City name

Required string length: 1 - 64

ship_to.country

string

required

Country name

Required string length: 1 - 128

ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

ship_to.province

string

required

State name

Required string length: 1 - 32

ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

ship_to.email

string | null

Contact email address

Maximum length: 128

ship_to.fax

string | null

Fax number

Maximum length: 32

ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

ship_to.phone1

string | null

Primary contact number

Maximum length: 32

ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

shipping_charged

string

Shipped charged

shipping_method

object

Show child attributes

shipping_method.code

string

required

Code of shipping method

Required string length: 1 - 64

shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 64

shipping_method.carrier

object

Show child attributes

shipping_method.carrier.code

string

Carrier code

Required string length: 1 - 64

shipping_method.carrier.name

string

Carrier name

Required string length: 1 - 64

shipping_method.generic_shipping_method

object

Show child attributes

shipping_method.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

shipping_method.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

shipping_method.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

signature

enum<string> | null

Represents whether signature is required

Available options:

required,

not_required,

adult

sold_to

object

Show child attributes

sold_to.city

string

required

City name

Required string length: 1 - 64

sold_to.country

string

required

Country name

Required string length: 1 - 128

sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

sold_to.province

string

required

State name

Required string length: 1 - 32

sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

sold_to.email

string | null

Contact email address

Maximum length: 128

sold_to.fax

string | null

Fax number

Maximum length: 32

sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

sold_to.phone1

string | null

Primary contact number

Maximum length: 32

sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Response

201 - application/json

ordered_at

string

required

Time of order finalization (UTC format)

purchase_order_number

string

required

Purchase order number

Minimum length: 1

acknowledged_at

string | null

Time of order acknowledgement (UTC format)

allow_shipping_label_generation

boolean

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

attachments

object[]

Show child attributes

attachments.content_type

integer

Content type

attachments.file

string | null

File name

attachments.filename

string | null

File name used for sharing

Maximum length: 255

attachments.id

integer

Attachment or document ID

attachments.object_id

integer

Attachement object ID

attachments.original_filename

string | null

Original file name

Maximum length: 255

attachments.tags

object[]

Show child attributes

attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

attachments.tags.id

integer

Attachment tag ID

attachments.uploaded_by

integer | null

User ID that uploaded the attachment

attachments.url

string

URL of attachment

Minimum length: 1

attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

backorder_acknowledged_at

string | null

Time of backorder acknowledgement (UTC format)

backordered_until

string | null

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

bill_to

object

Show child attributes

bill_to.city

string

required

City name

Required string length: 1 - 64

bill_to.country

string

required

Country name

Required string length: 1 - 128

bill_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

bill_to.postal_code

string

required

Postal code

Required string length: 1 - 32

bill_to.province

string

required

State name

Required string length: 1 - 32

bill_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

bill_to.email

string | null

Contact email address

Maximum length: 128

bill_to.fax

string | null

Fax number

Maximum length: 32

bill_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

bill_to.id

integer

Address ID

bill_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

bill_to.phone1

string | null

Primary contact number

Maximum length: 32

bill_to.phone2

string | null

Alternate contact number

Maximum length: 32

bill_to.street2

string | null

Line 2 of the address

Maximum length: 128

bill_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

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

brand.cover_url

string

URL of the cover image

Minimum length: 1

brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

brand.id

integer

Vendor (brand) ID

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

brand.is_on_rcn

boolean

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

brand.is_onboarded

boolean

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

brand.joined_at

string

Time when vendor joined Dropship (UTC format)

brand.logo_url

string

URL of the brand logo

Minimum length: 1

brand.name

string

Vendor name

Required string length: 1 - 64

brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

brand.subscription_is_delinquent

boolean

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

brand.subscription_is_expired

boolean

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

brand.subscription_is_on_grace_period

boolean

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

brand.website

string | null

URL of brand website

Maximum length: 100

brand_identifier

string | null

Vendor identifier

Maximum length: 64

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

brands.cover_url

string

URL of the cover image

Minimum length: 1

brands.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

brands.id

integer

Vendor (brand) ID

brands.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

brands.is_on_rcn

boolean

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

brands.is_onboarded

boolean

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

brands.joined_at

string

Time when vendor joined Dropship (UTC format)

brands.logo_url

string

URL of the brand logo

Minimum length: 1

brands.name

string

Vendor name

Required string length: 1 - 64

brands.profile_tile_url

string

URL of the profile image

Minimum length: 1

brands.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brands.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

brands.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

brands.subscription_is_delinquent

boolean

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

brands.subscription_is_expired

boolean

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

brands.subscription_is_on_grace_period

boolean

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

brands.website

string | null

URL of brand website

Maximum length: 100

canceled_at

string | null

Time of order cancellation (UTC format)

cancels

object[]

Show child attributes

cancels.reason_id

integer

required

Reason ID associated with cancellation

cancels.acknowledged_at

string | null

Time of cancellation acknowledgement (UTC format)

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

cancels.brand.id

integer

Vendor ID

cancels.brand.name

string

Vendor name

Required string length: 1 - 64

cancels.cancel_lines

object[]

Show child attributes

cancels.cancel_lines.estimated_availability_date

string | null

Estimated availability date of variant

cancels.cancel_lines.id

integer

Cancel line ID

cancels.cancel_lines.quantity

integer

Variant quantity

Required range: -2147483648 < x < 2147483647

cancels.cancel_lines.variant

string

Variant name

cancels.canceled_at

string | null

Time of cancellation (UTC format)

cancels.canceled_by

enum<string> | null

User that initiated cancellation

Available options:

retailer,

brand

cancels.id

integer

Cancellation ID

cancels.order_id

integer

Order ID

cancels.purchase_order_number

string

Purchase order number

Minimum length: 1

cancels.reason

string

Cancellation reason

Minimum length: 1

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

cancels.retailer.name

string

required

Retailer name

Required string length: 1 - 64

cancels.retailer.id

integer

Retailer ID

closed_at

string

Time of complete order fulfillment (UTC format)

connection_id

integer

A numeric connection ID

connection_shipping_provider_account

object

Show child attributes

connection_shipping_provider_account.connection

object

Show child attributes

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

connection_shipping_provider_account.connection.brand.cover_url

string

URL of the cover image

Minimum length: 1

connection_shipping_provider_account.connection.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

connection_shipping_provider_account.connection.brand.id

integer

Vendor (brand) ID

connection_shipping_provider_account.connection.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

connection_shipping_provider_account.connection.brand.is_on_rcn

boolean

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

connection_shipping_provider_account.connection.brand.is_onboarded

boolean

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

connection_shipping_provider_account.connection.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

connection_shipping_provider_account.connection.brand.logo_url

string

URL of the brand logo

Minimum length: 1

connection_shipping_provider_account.connection.brand.name

string

Vendor name

Required string length: 1 - 64

connection_shipping_provider_account.connection.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

connection_shipping_provider_account.connection.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

connection_shipping_provider_account.connection.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

connection_shipping_provider_account.connection.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

connection_shipping_provider_account.connection.brand.subscription_is_delinquent

boolean

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

connection_shipping_provider_account.connection.brand.subscription_is_expired

boolean

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

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

connection_shipping_provider_account.connection.brand.website

string | null

URL of brand website

Maximum length: 100

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

connection_shipping_provider_account.connection.connection_adjustments.adjustment_amount

string

Adjustment amount

connection_shipping_provider_account.connection.connection_adjustments.adjustment_amount_type

enum<string>

Adjustment type - dollar amount or percentage

Available options:

percent,

flat

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

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

connection_shipping_provider_account.connection.connection_adjustments.adjustment_code.id

integer

Adjustment ID

connection_shipping_provider_account.connection.connection_adjustments.adjustment_type

string

Adjustment type

connection_shipping_provider_account.connection.connection_adjustments.content_type

string

Content type

Minimum length: 1

connection_shipping_provider_account.connection.connection_adjustments.id

integer

Connection adjustment ID, used for monetary adjustments

connection_shipping_provider_account.connection.connection_adjustments.object_id

integer | null

Object ID

Required range: 0 < x < 4294967295

connection_shipping_provider_account.connection.created_at

string

Time of connection creation

connection_shipping_provider_account.connection.id

integer

Connection ID

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

connection_shipping_provider_account.connection.level

enum<string>

Connection type

Available options:

basic,

full

connection_shipping_provider_account.connection.metadata

string

Metadata

connection_shipping_provider_account.connection.options

object

Show child attributes

connection_shipping_provider_account.connection.options.code

string

required

Option code

Required string length: 1 - 64

connection_shipping_provider_account.connection.options.name

string

required

Option name

Required string length: 1 - 64

connection_shipping_provider_account.connection.options.description

string | null

Connection description

connection_shipping_provider_account.connection.options.editable_by

enum<string> | null

User who can edit connection

Available options:

retailer,

brand,

staff

connection_shipping_provider_account.connection.options.id

integer

Option ID

connection_shipping_provider_account.connection.options.viewable_by

enum<string> | null

User who can view the connection details

Available options:

retailer,

brand,

all,

none

connection_shipping_provider_account.connection.retailer

object

Show child attributes

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

connection_shipping_provider_account.connection.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

connection_shipping_provider_account.connection.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

connection_shipping_provider_account.connection.retailer.id

integer

Retailer ID

connection_shipping_provider_account.connection.retailer.is_onboarded

boolean

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

connection_shipping_provider_account.connection.retailer.is_rcn_retailer

boolean

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

connection_shipping_provider_account.connection.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

connection_shipping_provider_account.connection.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

connection_shipping_provider_account.connection.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

connection_shipping_provider_account.connection.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

connection_shipping_provider_account.connection.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

connection_shipping_provider_account.connection.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

connection_shipping_provider_account.connection.retailer.website

string | null

Website URL

Maximum length: 100

connection_shipping_provider_account.connection.retailer_identifier

string | null

Variant identifier specific to retailer

Maximum length: 32

connection_shipping_provider_account.connection.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

connection_shipping_provider_account.created_at

string

Time of creation (UTC format)

connection_shipping_provider_account.id

integer

Shipping carrier account ID

connection_shipping_provider_account.shipping_methods

object

Show child attributes

connection_shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.carrier

object

Show child attributes

connection_shipping_provider_account.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.carrier.id

integer

Carrier ID

connection_shipping_provider_account.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

connection_shipping_provider_account.shipping_methods.generic_shipping_method

object

Show child attributes

connection_shipping_provider_account.shipping_methods.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

connection_shipping_provider_account.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

connection_shipping_provider_account.shipping_methods.generic_shipping_method.id

integer

ID of shipping method

connection_shipping_provider_account.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_methods.id

integer

ID of shipping method

connection_shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_provider_account

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.created_at

string

Time of account (UTC format)

connection_shipping_provider_account.shipping_provider_account.credential_values

object[]

Show child attributes

connection_shipping_provider_account.shipping_provider_account.credential_values.created_at

string

Time of credentials creation (UTC format)

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

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.data_type

enum<string>

required

Data type of credentials

Available options:

text,

boolean

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.name

string

required

Credentials code

Required string length: 1 - 64

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.created_at

string

Time of credentials creation (UTC format)

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.id

integer

Credentials ID

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

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

connection_shipping_provider_account.shipping_provider_account.credential_values.credential.updated_at

string

Time of credentials update (UTC format)

connection_shipping_provider_account.shipping_provider_account.credential_values.id

integer

Credentials ID

connection_shipping_provider_account.shipping_provider_account.credential_values.updated_at

string

Time of credentials update (UTC format)

connection_shipping_provider_account.shipping_provider_account.credential_values.value

string

Credentials value

connection_shipping_provider_account.shipping_provider_account.id

integer

Account ID of shipping provider

connection_shipping_provider_account.shipping_provider_account.shipping_methods

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.id

integer

Carrier ID

connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

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

string

required

Description of shipping method

Required string length: 1 - 128

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.id

integer

ID of shipping method

connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_provider_account.shipping_methods.id

integer

ID of shipping method

connection_shipping_provider_account.shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

connection_shipping_provider_account.shipping_provider_account.shipping_provider

object

Show child attributes

connection_shipping_provider_account.shipping_provider_account.shipping_provider.created_at

string

Time of shipping provider creation (UTC format)

connection_shipping_provider_account.shipping_provider_account.shipping_provider.credentials

string

Credentials for shipping provider

connection_shipping_provider_account.shipping_provider_account.shipping_provider.id

integer

Shipping provider ID

connection_shipping_provider_account.shipping_provider_account.shipping_provider.name

string | null

Name of shipping provider

Maximum length: 32

connection_shipping_provider_account.shipping_provider_account.shipping_provider.shipping_methods

string

Shipping methods

connection_shipping_provider_account.shipping_provider_account.shipping_provider.updated_at

string

Time of shipping provider update (UTC format)

connection_shipping_provider_account.shipping_provider_account.updated_at

string

Time of account update (UTC format)

connection_shipping_provider_account.updated_at

string

Time of last update (UTC format)

credits

object[]

Show child attributes

credits.acknowledged_at

string | null

Time of credit acknowledgement

credits.adjustments

object[]

Show child attributes

credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

credits.adjustments.id

integer

Adjustment ID

credits.adjustments.net_price

string

Adjustment net price

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

credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

credits.brand.id

integer

Vendor (brand) ID

credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

credits.brand.is_on_rcn

boolean

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

credits.brand.is_onboarded

boolean

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

credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

credits.brand.name

string

Vendor name

Required string length: 1 - 64

credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

credits.brand.subscription_is_delinquent

boolean

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

credits.brand.subscription_is_expired

boolean

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

credits.brand.subscription_is_on_grace_period

boolean

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

credits.brand.website

string | null

URL of brand website

Maximum length: 100

credits.created_at

string

Time of creation (UTC format)

credits.credit_amount

string

Credit amount

credits.credit_lines

object[]

Show child attributes

credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 < x < 2147483647

credits.credit_lines.id

integer

Credit line ID

credits.credit_lines.net_price

string

Credit line net price

credits.credit_lines.variant

object

Show child attributes

credits.credit_lines.variant.active_permit

object

Show child attributes

credits.credit_lines.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

credits.credit_lines.variant.active_permit.attributes

object

credits.credit_lines.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

credits.credit_lines.variant.active_permit.id

integer

Permit ID

credits.credit_lines.variant.active_permit.is_acknowledged

boolean

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

credits.credit_lines.variant.active_permit.is_in_effect

boolean

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

credits.credit_lines.variant.active_permit.pricing

object

credits.credit_lines.variant.active_permit.retailer

object

Show child attributes

credits.credit_lines.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

credits.credit_lines.variant.active_permit.retailer_price

string | null

Retailer price of the variant

credits.credit_lines.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

credits.credit_lines.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

credits.credit_lines.variant.attributes

object[]

Show child attributes

credits.credit_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

credits.credit_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

credits.credit_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

credits.credit_lines.variant.attributes.description

string | null

Attribute description

credits.credit_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

credits.credit_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

credits.credit_lines.variant.attributes.id

integer

Attribute ID

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

credits.credit_lines.variant.attributes.values

object

Show child attributes

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

credits.credit_lines.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

credits.credit_lines.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

credits.credit_lines.variant.brand.id

integer

Vendor (brand) ID

credits.credit_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

credits.credit_lines.variant.brand.is_on_rcn

boolean

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

credits.credit_lines.variant.brand.is_onboarded

boolean

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

credits.credit_lines.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

credits.credit_lines.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

credits.credit_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

credits.credit_lines.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

credits.credit_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

credits.credit_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

credits.credit_lines.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

credits.credit_lines.variant.brand.subscription_is_delinquent

boolean

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

credits.credit_lines.variant.brand.subscription_is_expired

boolean

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

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

credits.credit_lines.variant.brand.website

string | null

URL of brand website

Maximum length: 100

credits.credit_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

credits.credit_lines.variant.cartons

object[]

Show child attributes

credits.credit_lines.variant.cartons.height

string | null

Carton height

credits.credit_lines.variant.cartons.height_unit

string

Unit of height

credits.credit_lines.variant.cartons.id

integer

Carton ID

credits.credit_lines.variant.cartons.length

string | null

Carton length

credits.credit_lines.variant.cartons.length_unit

string

Unit of length

credits.credit_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

credits.credit_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

credits.credit_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

credits.credit_lines.variant.cartons.weight

string | null

Carton weight

credits.credit_lines.variant.cartons.weight_unit

string

Unit of weight

credits.credit_lines.variant.cartons.width

string | null

Carton width

credits.credit_lines.variant.cartons.width_unit

string

Unit of width

credits.credit_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

credits.credit_lines.variant.id

integer

Variant ID

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

credits.credit_lines.variant.inventory

object

Show child attributes

credits.credit_lines.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

credits.credit_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

credits.credit_lines.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

credits.credit_lines.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

credits.credit_lines.variant.inventory.sellable_updated_at

string

required

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

credits.credit_lines.variant.inventory.discontinued

boolean

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

credits.credit_lines.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

credits.credit_lines.variant.inventory.inventory

integer

Inventory of variant

credits.credit_lines.variant.inventory.locations

object[]

Show child attributes

credits.credit_lines.variant.inventory.replenishable

boolean

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

credits.credit_lines.variant.inventory.sellable

string

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

credits.credit_lines.variant.is_compatible

boolean

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

credits.credit_lines.variant.media

object[]

Show child attributes

credits.credit_lines.variant.media.created_at

string

Time of variant image creation (UTC format)

credits.credit_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

credits.credit_lines.variant.media.id

integer

Variant ID

credits.credit_lines.variant.media.media

string

Variant images

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

credits.credit_lines.variant.media.updated_at

string

Time of variant image update (UTC format)

credits.credit_lines.variant.media.url

string

URL of variant image

credits.credit_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

credits.credit_lines.variant.name

string | null

Variant Name

Maximum length: 200

credits.credit_lines.variant.permits

object[]

Show child attributes

credits.credit_lines.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

credits.credit_lines.variant.permits.attributes

object

credits.credit_lines.variant.permits.end_at

string | null

Time of permit end (UTC format)

credits.credit_lines.variant.permits.id

integer

Permit ID

credits.credit_lines.variant.permits.is_acknowledged

boolean

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

credits.credit_lines.variant.permits.is_in_effect

boolean

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

credits.credit_lines.variant.permits.pricing

object

credits.credit_lines.variant.permits.retailer

object

Show child attributes

credits.credit_lines.variant.permits.retailer_cost

string | null

Retailer cost of variant

credits.credit_lines.variant.permits.retailer_price

string | null

Retailer price of the variant

credits.credit_lines.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

credits.credit_lines.variant.permits.start_at

string | null

Time of permit start (UTC format)

credits.credit_lines.variant.proposal_variant

object

Show child attributes

credits.credit_lines.variant.proposal_variant.approve

boolean

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

credits.credit_lines.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

credits.credit_lines.variant.proposal_variant.attributes

object[]

Show child attributes

credits.credit_lines.variant.proposal_variant.created_at

string

Time of creation (UTC format)

credits.credit_lines.variant.proposal_variant.delete

boolean

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

credits.credit_lines.variant.proposal_variant.id

integer

Proposal variant ID

credits.credit_lines.variant.proposal_variant.issues

object[]

Show child attributes

credits.credit_lines.variant.proposal_variant.memos

object[]

Show child attributes

credits.credit_lines.variant.proposal_variant.pricing

string

Pricing of variant

credits.credit_lines.variant.proposal_variant.reject

boolean

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

credits.credit_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

credits.credit_lines.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

credits.credit_lines.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

credits.credit_lines.variant.proposal_variant.variant_id

integer

Variant ID

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

credits.credit_lines.variant.retailer_categories.id

integer

Retailer category ID

credits.credit_lines.variant.retailer_categories.retailer

object

Show child attributes

credits.credit_lines.variant.retailer_identifiers

object

Show child attributes

credits.credit_lines.variant.retailer_identifiers.id

integer

Retailer ID

credits.credit_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

credits.credit_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

credits.credit_lines.variant.retailer_identifiers.retailer

object

Show child attributes

credits.credit_lines.variant.ruleset_variant_summary

string

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

credits.credit_lines.variant.ruleset_variants

object[]

Show child attributes

credits.credit_lines.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

credits.credit_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

credits.credit_lines.variant.ruleset_variants.results

string

Response

credits.credit_lines.variant.ruleset_variants.ruleset

object

Show child attributes

credits.credit_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

credits.credit_lines.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

credits.credit_lines.variant.size

string | null

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

Maximum length: 128

credits.credit_lines.variant.style

string | null

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

Maximum length: 128

credits.credit_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

credits.credit_number

string | null

Credit number

Maximum length: 32

credits.credited_at

string | null

Time of credit (UTC format)

credits.currency

object

Show child attributes

credits.currency.id

integer

Currency ID

credits.currency.name

string

Currency name

Maximum length: 200

credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

credits.currency.unit

string

Currency unit

credits.id

integer

Credit ID

credits.invoice

object

Show child attributes

credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

credits.invoice.allowances

object[]

Show child attributes

credits.invoice.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

credits.invoice.allowances.price

string

required

Allowance price

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

credits.invoice.allowances.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

credits.invoice.allowances.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

credits.invoice.allowances.adjustment_code.id

integer

Adjustment ID

credits.invoice.allowances.id

integer

Allowance ID

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

credits.invoice.brand.cover_url

string

URL of the cover image

Minimum length: 1

credits.invoice.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

credits.invoice.brand.id

integer

Vendor (brand) ID

credits.invoice.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

credits.invoice.brand.is_on_rcn

boolean

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

credits.invoice.brand.is_onboarded

boolean

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

credits.invoice.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

credits.invoice.brand.logo_url

string

URL of the brand logo

Minimum length: 1

credits.invoice.brand.name

string

Vendor name

Required string length: 1 - 64

credits.invoice.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

credits.invoice.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

credits.invoice.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

credits.invoice.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

credits.invoice.brand.subscription_is_delinquent

boolean

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

credits.invoice.brand.subscription_is_expired

boolean

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

credits.invoice.brand.subscription_is_on_grace_period

boolean

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

credits.invoice.brand.website

string | null

URL of brand website

Maximum length: 100

credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

credits.invoice.charges

object[]

Show child attributes

credits.invoice.charges.description

string

required

Invoice description

Required string length: 1 - 128

credits.invoice.charges.price

string

required

Invoice price

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

credits.invoice.charges.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

credits.invoice.charges.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

credits.invoice.charges.adjustment_code.id

integer

Adjustment ID

credits.invoice.charges.id

integer

Invoice ID

credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

credits.invoice.connection_id

string

Connection ID

credits.invoice.currency

object

Show child attributes

credits.invoice.currency.id

integer

Currency ID

credits.invoice.currency.name

string

Currency name

Maximum length: 200

credits.invoice.currency.symbol

string | null

Currency symbol

Maximum length: 5

credits.invoice.currency.unit

string

Currency unit

credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

credits.invoice.due_amount

string | null

Pending amount

credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

credits.invoice.id

integer

Invoice ID

credits.invoice.invoice_acceptance

object

Show child attributes

credits.invoice.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

credits.invoice.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

credits.invoice.invoice_acceptance.accepted_by.first_name

string | null

First name of user

Maximum length: 64

credits.invoice.invoice_acceptance.accepted_by.id

integer

User ID who accepted or rejected the invoice

credits.invoice.invoice_acceptance.accepted_by.is_me

boolean

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

credits.invoice.invoice_acceptance.accepted_by.last_name

string | null

Last name of user

Maximum length: 64

credits.invoice.invoice_acceptance.accepted_by.photo_url

string

URL of the user photo

Minimum length: 1

credits.invoice.invoice_acceptance.accepted_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

credits.invoice.invoice_acceptance.accepted_by.status

enum<string>

User status

Available options:

active,

invited,

locked

credits.invoice.invoice_acceptance.accepted_by.title

string | null

User title

Maximum length: 64

credits.invoice.invoice_acceptance.accepted_by.type

enum<string>

User type

Available options:

standard,

api

credits.invoice.invoice_acceptance.id

integer

Invoice acceptance ID

credits.invoice.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

credits.invoice.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

credits.invoice.invoice_acceptance.rejected_by

object

Show child attributes

credits.invoice.invoice_acceptance.rejected_by.first_name

string | null

First name of user

Maximum length: 64

credits.invoice.invoice_acceptance.rejected_by.id

integer

User ID who accepted or rejected the invoice

credits.invoice.invoice_acceptance.rejected_by.is_me

boolean

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

credits.invoice.invoice_acceptance.rejected_by.last_name

string | null

Last name of user

Maximum length: 64

credits.invoice.invoice_acceptance.rejected_by.photo_url

string

URL of the user photo

Minimum length: 1

credits.invoice.invoice_acceptance.rejected_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

credits.invoice.invoice_acceptance.rejected_by.status

enum<string>

User status

Available options:

active,

invited,

locked

credits.invoice.invoice_acceptance.rejected_by.title

string | null

User title

Maximum length: 64

credits.invoice.invoice_acceptance.rejected_by.type

enum<string>

User type

Available options:

standard,

api

credits.invoice.invoice_lines

object[]

Show child attributes

credits.invoice.invoice_lines.price

string

required

Discounted price

credits.invoice.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 < x < 2147483647

credits.invoice.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

credits.invoice.invoice_lines.description

string | null

Product description

Maximum length: 128

credits.invoice.invoice_lines.id

integer

Invoice line ID

credits.invoice.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 < x < 2147483647

credits.invoice.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

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

credits.invoice.invoice_lines.name

string | null

Product name

Maximum length: 128

credits.invoice.invoice_lines.retail_price

string

Retail price

credits.invoice.invoice_lines.variant

object

Show child attributes

credits.invoice.invoice_lines.variant.active_permit

object

Show child attributes

credits.invoice.invoice_lines.variant.attributes

object[]

Show child attributes

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

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

credits.invoice.invoice_lines.variant.id

integer

Variant ID

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

credits.invoice.invoice_lines.variant.inventory

object

Show child attributes

credits.invoice.invoice_lines.variant.is_compatible

boolean

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

credits.invoice.invoice_lines.variant.media

object[]

Show child attributes

credits.invoice.invoice_lines.variant.name

string | null

Variant Name

Maximum length: 200

credits.invoice.invoice_lines.variant.permits

object[]

Show child attributes

credits.invoice.invoice_lines.variant.proposal_variant

object

Show child attributes

credits.invoice.invoice_lines.variant.retailer_categories

object

Show child attributes

credits.invoice.invoice_lines.variant.retailer_identifiers

object

Show child attributes

credits.invoice.invoice_lines.variant.ruleset_variant_summary

string

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

credits.invoice.invoice_lines.variant.ruleset_variants

object[]

Show child attributes

credits.invoice.invoice_lines.variant.size

string | null

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

Maximum length: 128

credits.invoice.invoice_lines.variant.style

string | null

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

Maximum length: 128

credits.invoice.invoice_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

credits.invoice.notes

string | null

Addition info adding to shipping

credits.invoice.order_id

integer

Order ID related to invoice

credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

credits.invoice.paid_at

string | null

Time of payment (UTC format)

credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

credits.invoice.remit_to

object

Show child attributes

credits.invoice.remit_to.city

string

required

City name

Required string length: 1 - 64

credits.invoice.remit_to.country

string

required

Country name

Required string length: 1 - 128

credits.invoice.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

credits.invoice.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

credits.invoice.remit_to.province

string

required

State name

Required string length: 1 - 32

credits.invoice.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

credits.invoice.remit_to.email

string | null

Contact email address

Maximum length: 128

credits.invoice.remit_to.fax

string | null

Fax number

Maximum length: 32

credits.invoice.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

credits.invoice.remit_to.id

integer

Address ID

credits.invoice.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

credits.invoice.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

credits.invoice.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

credits.invoice.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

credits.invoice.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

credits.invoice.retailer

object

Show child attributes

credits.invoice.retailer.code

string

required

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

Required string length: 1 - 32

credits.invoice.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

credits.invoice.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

credits.invoice.retailer.id

integer

Retailer ID

credits.invoice.retailer.is_onboarded

boolean

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

credits.invoice.retailer.is_rcn_retailer

boolean

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

credits.invoice.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

credits.invoice.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

credits.invoice.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

credits.invoice.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

credits.invoice.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

credits.invoice.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

credits.invoice.retailer.website

string | null

Website URL

Maximum length: 100

credits.invoice.ship_from

object

Show child attributes

credits.invoice.ship_from.city

string

required

City name

Required string length: 1 - 64

credits.invoice.ship_from.country

string

required

Country name

Required string length: 1 - 128

credits.invoice.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

credits.invoice.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

credits.invoice.ship_from.province

string

required

State name

Required string length: 1 - 32

credits.invoice.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

credits.invoice.ship_from.email

string | null

Contact email address

Maximum length: 128

credits.invoice.ship_from.fax

string | null

Fax number

Maximum length: 32

credits.invoice.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

credits.invoice.ship_from.id

integer

Address ID

credits.invoice.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

credits.invoice.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

credits.invoice.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

credits.invoice.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

credits.invoice.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

credits.invoice.ship_to

object

Show child attributes

credits.invoice.ship_to.city

string

required

City name

Required string length: 1 - 64

credits.invoice.ship_to.country

string

required

Country name

Required string length: 1 - 128

credits.invoice.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

credits.invoice.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

credits.invoice.ship_to.province

string

required

State name

Required string length: 1 - 32

credits.invoice.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

credits.invoice.ship_to.email

string | null

Contact email address

Maximum length: 128

credits.invoice.ship_to.fax

string | null

Fax number

Maximum length: 32

credits.invoice.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

credits.invoice.ship_to.id

integer

Address ID

credits.invoice.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

credits.invoice.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

credits.invoice.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

credits.invoice.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

credits.invoice.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

credits.invoice.shipping_weight

string | null

Shipping weight

credits.invoice.sold_to

object

Show child attributes

credits.invoice.sold_to.city

string

required

City name

Required string length: 1 - 64

credits.invoice.sold_to.country

string

required

Country name

Required string length: 1 - 128

credits.invoice.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

credits.invoice.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

credits.invoice.sold_to.province

string

required

State name

Required string length: 1 - 32

credits.invoice.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

credits.invoice.sold_to.email

string | null

Contact email address

Maximum length: 128

credits.invoice.sold_to.fax

string | null

Fax number

Maximum length: 32

credits.invoice.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

credits.invoice.sold_to.id

integer

Address ID

credits.invoice.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

credits.invoice.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

credits.invoice.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

credits.invoice.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

credits.invoice.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

credits.invoice.subtotal

string | null

Sub-total

credits.invoice.tax

string | null

Total tax on the invoice

credits.invoice.terms_date_due

string | null

Payment expected date

credits.invoice.terms_description

string | null

Description of invoice terms

credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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

credits.order

string

Order details

credits.retailer

object

Show child attributes

credits.retailer.code

string

required

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

Required string length: 1 - 32

credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

credits.retailer.brand_permit_creation_allowed

boolean

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

credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

credits.retailer.id

integer

Retailer ID

credits.retailer.is_onboarded

boolean

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

credits.retailer.is_rcn_retailer

boolean

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

credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

credits.retailer.website

string | null

Website URL

Maximum length: 100

credits.rma

object

Show child attributes

credits.rma.order_id

integer

required

Order ID

credits.rma.reason_id

integer

required

ID associated with return reason

credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

credits.rma.attachments

object[]

Show child attributes

credits.rma.attachments.content_type

integer

Content type

credits.rma.attachments.file

string | null

File name

credits.rma.attachments.filename

string | null

File name used for sharing

Maximum length: 255

credits.rma.attachments.id

integer

Attachment or document ID

credits.rma.attachments.object_id

integer

Attachement object ID

credits.rma.attachments.original_filename

string | null

Original file name

Maximum length: 255

credits.rma.attachments.tags

object[]

Show child attributes

credits.rma.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

credits.rma.attachments.tags.id

integer

Attachment tag ID

credits.rma.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

credits.rma.attachments.url

string

URL of attachment

Minimum length: 1

credits.rma.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

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

credits.rma.brand.cover_url

string

URL of the cover image

Minimum length: 1

credits.rma.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

credits.rma.brand.id

integer

Vendor (brand) ID

credits.rma.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

credits.rma.brand.is_on_rcn

boolean

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

credits.rma.brand.is_onboarded

boolean

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

credits.rma.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

credits.rma.brand.logo_url

string

URL of the brand logo

Minimum length: 1

credits.rma.brand.name

string

Vendor name

Required string length: 1 - 64

credits.rma.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

credits.rma.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

credits.rma.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

credits.rma.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

credits.rma.brand.subscription_is_delinquent

boolean

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

credits.rma.brand.subscription_is_expired

boolean

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

credits.rma.brand.subscription_is_on_grace_period

boolean

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

credits.rma.brand.website

string | null

URL of brand website

Maximum length: 100

credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

credits.rma.credits

object[]

Show child attributes

credits.rma.credits.acknowledged_at

string | null

Time of credit acknowledgement

credits.rma.credits.adjustments

object[]

Show child attributes

credits.rma.credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

credits.rma.credits.adjustments.id

integer

Adjustment ID

credits.rma.credits.adjustments.net_price

string

Adjustment net price

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

credits.rma.credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

credits.rma.credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

credits.rma.credits.brand.id

integer

Vendor (brand) ID

credits.rma.credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

credits.rma.credits.brand.is_on_rcn

boolean

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

credits.rma.credits.brand.is_onboarded

boolean

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

credits.rma.credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

credits.rma.credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

credits.rma.credits.brand.name

string

Vendor name

Required string length: 1 - 64

credits.rma.credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

credits.rma.credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

credits.rma.credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

credits.rma.credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

credits.rma.credits.brand.subscription_is_delinquent

boolean

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

credits.rma.credits.brand.subscription_is_expired

boolean

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

credits.rma.credits.brand.subscription_is_on_grace_period

boolean

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

credits.rma.credits.brand.website

string | null

URL of brand website

Maximum length: 100

credits.rma.credits.created_at

string

Time of creation (UTC format)

credits.rma.credits.credit_amount

string

Credit amount

credits.rma.credits.credit_lines

object[]

Show child attributes

credits.rma.credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 < x < 2147483647

credits.rma.credits.credit_lines.id

integer

Credit line ID

credits.rma.credits.credit_lines.net_price

string

Credit line net price

credits.rma.credits.credit_lines.variant

object

Show child attributes

credits.rma.credits.credit_number

string | null

Credit number

Maximum length: 32

credits.rma.credits.credited_at

string | null

Time of credit (UTC format)

credits.rma.credits.currency

object

Show child attributes

credits.rma.credits.currency.id

integer

Currency ID

credits.rma.credits.currency.name

string

Currency name

Maximum length: 200

credits.rma.credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

credits.rma.credits.currency.unit

string

Currency unit

credits.rma.credits.id

integer

Credit ID

credits.rma.credits.invoice

object

Show child attributes

credits.rma.credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

credits.rma.credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

credits.rma.credits.invoice.allowances

object[]

Show child attributes

credits.rma.credits.invoice.brand

object

Show child attributes

credits.rma.credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

credits.rma.credits.invoice.charges

object[]

Show child attributes

credits.rma.credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

credits.rma.credits.invoice.connection_id

string

Connection ID

credits.rma.credits.invoice.currency

object

Show child attributes

credits.rma.credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

credits.rma.credits.invoice.due_amount

string | null

Pending amount

credits.rma.credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

credits.rma.credits.invoice.id

integer

Invoice ID

credits.rma.credits.invoice.invoice_acceptance

object

Show child attributes

credits.rma.credits.invoice.invoice_lines

object[]

Show child attributes

credits.rma.credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

credits.rma.credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

credits.rma.credits.invoice.notes

string | null

Addition info adding to shipping

credits.rma.credits.invoice.order_id

integer

Order ID related to invoice

credits.rma.credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

credits.rma.credits.invoice.paid_at

string | null

Time of payment (UTC format)

credits.rma.credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

credits.rma.credits.invoice.remit_to

object

Show child attributes

credits.rma.credits.invoice.retailer

object

Show child attributes

credits.rma.credits.invoice.ship_from

object

Show child attributes

credits.rma.credits.invoice.ship_to

object

Show child attributes

credits.rma.credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

credits.rma.credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

credits.rma.credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

credits.rma.credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

credits.rma.credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

credits.rma.credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

credits.rma.credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

credits.rma.credits.invoice.shipping_weight

string | null

Shipping weight

credits.rma.credits.invoice.sold_to

object

Show child attributes

credits.rma.credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

credits.rma.credits.invoice.subtotal

string | null

Sub-total

credits.rma.credits.invoice.tax

string | null

Total tax on the invoice

credits.rma.credits.invoice.terms_date_due

string | null

Payment expected date

credits.rma.credits.invoice.terms_description

string | null

Description of invoice terms

credits.rma.credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

credits.rma.credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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

credits.rma.credits.order

string

Order details

credits.rma.credits.retailer

object

Show child attributes

credits.rma.credits.retailer.code

string

required

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

Required string length: 1 - 32

credits.rma.credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

credits.rma.credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

credits.rma.credits.retailer.id

integer

Retailer ID

credits.rma.credits.retailer.is_onboarded

boolean

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

credits.rma.credits.retailer.is_rcn_retailer

boolean

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

credits.rma.credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

credits.rma.credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

credits.rma.credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

credits.rma.credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

credits.rma.credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

credits.rma.credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

credits.rma.credits.retailer.website

string | null

Website URL

Maximum length: 100

credits.rma.credits.rma

object

Show child attributes

credits.rma.credits.rma.order_id

integer

required

Order ID

credits.rma.credits.rma.reason_id

integer

required

ID associated with return reason

credits.rma.credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

credits.rma.credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

credits.rma.credits.rma.attachments

object[]

Show child attributes

credits.rma.credits.rma.brand

object

Show child attributes

credits.rma.credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

credits.rma.credits.rma.credits

object[]

Show child attributes

credits.rma.credits.rma.currency

object

Show child attributes

credits.rma.credits.rma.id

integer

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

credits.rma.credits.rma.memos

object[]

Show child attributes

credits.rma.credits.rma.ordered_at

string

Time of order finalization (UTC format)

credits.rma.credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

credits.rma.credits.rma.reason

string

Reason for return

Minimum length: 1

credits.rma.credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

credits.rma.credits.rma.retailer

object

Show child attributes

credits.rma.credits.rma.rma_lines

object[]

Show child attributes

credits.rma.credits.rma.rma_number

string | null

RMA number

Maximum length: 32

credits.rma.credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

credits.rma.credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

credits.rma.credits.rma.total_amount

string

Total amount

credits.rma.credits.subtotal

string

Subtotal amount

credits.rma.currency

object

Show child attributes

credits.rma.currency.id

integer

Currency ID

credits.rma.currency.name

string

Currency name

Maximum length: 200

credits.rma.currency.symbol

string | null

Currency symbol

Maximum length: 5

credits.rma.currency.unit

string

Currency unit

credits.rma.id

integer

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

credits.rma.memos

object[]

Show child attributes

credits.rma.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

credits.rma.memos.created_at

string

Time of memo creation (UTC format)

credits.rma.memos.created_by

object

Show child attributes

credits.rma.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

credits.rma.memos.created_by.id

integer

User ID who accepted or rejected the invoice

credits.rma.memos.created_by.is_me

boolean

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

credits.rma.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

credits.rma.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

credits.rma.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

credits.rma.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

credits.rma.memos.created_by.title

string | null

User title

Maximum length: 64

credits.rma.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

credits.rma.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

credits.rma.memos.id

integer

Memo ID

credits.rma.memos.notify_people

boolean

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

credits.rma.memos.text

string

Memo text

credits.rma.memos.updated_at

string

Time of memo update (UTC format)

credits.rma.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

credits.rma.ordered_at

string

Time of order finalization (UTC format)

credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

credits.rma.reason

string

Reason for return

Minimum length: 1

credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

credits.rma.retailer

object

Show child attributes

credits.rma.retailer.code

string

required

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

Required string length: 1 - 32

credits.rma.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

credits.rma.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

credits.rma.retailer.id

integer

Retailer ID

credits.rma.retailer.is_onboarded

boolean

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

credits.rma.retailer.is_rcn_retailer

boolean

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

credits.rma.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

credits.rma.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

credits.rma.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

credits.rma.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

credits.rma.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

credits.rma.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

credits.rma.retailer.website

string | null

Website URL

Maximum length: 100

credits.rma.rma_lines

object[]

Show child attributes

credits.rma.rma_lines.id

integer

RMA line ID

credits.rma.rma_lines.net_price

string

Net price

credits.rma.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 < x < 2147483647

credits.rma.rma_lines.quantity_shipped

integer

Quantity shipped

credits.rma.rma_lines.variant

object

Show child attributes

credits.rma.rma_lines.variant.active_permit

object

Show child attributes

credits.rma.rma_lines.variant.attributes

object[]

Show child attributes

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

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

credits.rma.rma_lines.variant.id

integer

Variant ID

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

credits.rma.rma_lines.variant.inventory

object

Show child attributes

credits.rma.rma_lines.variant.is_compatible

boolean

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

credits.rma.rma_lines.variant.media

object[]

Show child attributes

credits.rma.rma_lines.variant.name

string | null

Variant Name

Maximum length: 200

credits.rma.rma_lines.variant.permits

object[]

Show child attributes

credits.rma.rma_lines.variant.proposal_variant

object

Show child attributes

credits.rma.rma_lines.variant.retailer_categories

object

Show child attributes

credits.rma.rma_lines.variant.retailer_identifiers

object

Show child attributes

credits.rma.rma_lines.variant.ruleset_variant_summary

string

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

credits.rma.rma_lines.variant.ruleset_variants

object[]

Show child attributes

credits.rma.rma_lines.variant.size

string | null

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

Maximum length: 128

credits.rma.rma_lines.variant.style

string | null

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

Maximum length: 128

credits.rma.rma_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

credits.rma.rma_number

string | null

RMA number

Maximum length: 32

credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

credits.rma.total_amount

string

Total amount

credits.subtotal

string

Subtotal amount

currency

object

Show child attributes

currency.id

integer

Currency ID

currency.name

string

Currency name

Maximum length: 200

currency.symbol

string | null

Currency symbol

Maximum length: 5

currency.unit

string

Currency unit

customer_order_number

string | null

Customer order number

Maximum length: 64

envelopes

object[]

Show child attributes

envelopes.data_interchange_control_number

integer

required

Data interchange control number

Required range: 0 < x < 4294967295

envelopes.direction

enum<string>

required

Direction of envelop

Available options:

incoming,

outgoing

envelopes.functional_identifier

enum<string>

required

Functional identifier

Available options:

PO,

IN,

SH,

IB,

FA,

PR,

PC

envelopes.interchange_control_number

integer

required

Interchange control number

Required range: 0 < x < 4294967295

envelopes.accepted_at

string | null

Time of envelope acceptance (UTC format)

envelopes.created_at

string

Time of envelope creation (UTC format)

envelopes.documents

object[]

Show child attributes

envelopes.documents.transaction_set

enum<string>

required

Transaction set

Available options:

810,

846,

850,

855,

856,

860,

997

envelopes.documents.transaction_set_control_number

integer

required

Transaction set control number related to EDI

Required range: 0 < x < 4294967295

envelopes.documents.accepted_at

string | null

Time of document acceptance (UTC format)

envelopes.documents.id

integer

Document ID

envelopes.documents.jobs

object[]

Show child attributes

envelopes.documents.jobs.content_type

integer

required

Content type

envelopes.documents.jobs.module_name

string

required

Module name

Required string length: 1 - 64

envelopes.documents.jobs.object_id

integer

required

Object ID

Required range: 0 < x < 4294967295

envelopes.documents.jobs.runtime_id

string

required

Runtime ID

Required string length: 1 - 64

envelopes.documents.jobs.connection

object

Show child attributes

envelopes.documents.jobs.connection.brand

object

Show child attributes

envelopes.documents.jobs.connection.connection_adjustments

object[]

Show child attributes

envelopes.documents.jobs.connection.created_at

string

Time of connection creation

envelopes.documents.jobs.connection.id

integer

Connection ID

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

envelopes.documents.jobs.connection.level

enum<string>

Connection type

Available options:

basic,

full

envelopes.documents.jobs.connection.metadata

string

Metadata

envelopes.documents.jobs.connection.options

object

Show child attributes

envelopes.documents.jobs.connection.retailer

object

Show child attributes

envelopes.documents.jobs.connection.retailer_identifier

string | null

Variant identifier specific to retailer

Maximum length: 32

envelopes.documents.jobs.connection.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

envelopes.documents.jobs.created_at

string

Time of job creation (UTC format)

envelopes.documents.jobs.description

string

Bried description of job, for future reference

envelopes.documents.jobs.error_count

string

Error count

envelopes.documents.jobs.error_logs

object

Show child attributes

envelopes.documents.jobs.error_logs.count

integer

Count of error log

envelopes.documents.jobs.error_logs.created_at

string

Time of error log creation

envelopes.documents.jobs.error_logs.id

integer

Error log ID

envelopes.documents.jobs.error_logs.message

string | null

Message in error log

envelopes.documents.jobs.finish_time

string

Time of job ending (UTC format)

envelopes.documents.jobs.id

integer

Job ID

envelopes.documents.jobs.metadata

object[]

envelopes.documents.jobs.start_time

string

Time of job beginning (UTC format)

envelopes.documents.jobs.total_failure

string

Unsuccessful completion of job

envelopes.documents.jobs.total_success

string

Successful completion of job

envelopes.documents.rejected_at

string | null

Time of document rejection (UTC format)

envelopes.edi

string

Electronic data exchange (EDI)

envelopes.element_delimiter

string

Element delimiter

Required string length: 1 - 12

envelopes.entities

object[]

Show child attributes

envelopes.entities.content_type

integer

required

Content type

envelopes.entities.envelope

object

required

Show child attributes

envelopes.entities.envelope.data_interchange_control_number

integer

required

Data interchange control number

Required range: 0 < x < 4294967295

envelopes.entities.envelope.direction

enum<string>

required

Direction of envelop

Available options:

incoming,

outgoing

envelopes.entities.envelope.functional_identifier

enum<string>

required

Functional identifier

Available options:

PO,

IN,

SH,

IB,

FA,

PR,

PC

envelopes.entities.envelope.interchange_control_number

integer

required

Interchange control number

Required range: 0 < x < 4294967295

envelopes.entities.envelope.accepted_at

string | null

Time of envelope acceptance (UTC format)

envelopes.entities.envelope.created_at

string

Time of envelope creation (UTC format)

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

envelopes.entities.envelope.documents.transaction_set_control_number

integer

required

Transaction set control number related to EDI

Required range: 0 < x < 4294967295

envelopes.entities.envelope.documents.accepted_at

string | null

Time of document acceptance (UTC format)

envelopes.entities.envelope.documents.id

integer

Document ID

envelopes.entities.envelope.documents.jobs

object[]

Show child attributes

envelopes.entities.envelope.documents.rejected_at

string | null

Time of document rejection (UTC format)

envelopes.entities.envelope.edi

string

Electronic data exchange (EDI)

envelopes.entities.envelope.element_delimiter

string

Element delimiter

Required string length: 1 - 12

envelopes.entities.envelope.entities

object[]

Show child attributes

envelopes.entities.envelope.entities.content_type

integer

required

Content type

envelopes.entities.envelope.entities.envelope

object

required

Show child attributes

envelopes.entities.envelope.entities.object_id

integer

required

Object ID associated with the content type

Required range: 0 < x < 4294967295

envelopes.entities.envelope.entities.id

integer

Envelop entity ID

envelopes.entities.envelope.id

integer

Envelop ID

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

envelopes.entities.envelope.receiver.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

envelopes.entities.envelope.receiver.brand

object

Show child attributes

envelopes.entities.envelope.receiver.id

integer

EDI account ID

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

envelopes.entities.envelope.receiver.retailer

object

Show child attributes

envelopes.entities.envelope.receiver.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

envelopes.entities.envelope.rejected_at

string | null

Time of envelope rejection (UTC format)

envelopes.entities.envelope.request_acknowledgment

boolean

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

envelopes.entities.envelope.segment_delimiter

string

Segment delimited

Required string length: 1 - 12

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

envelopes.entities.envelope.sender.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

envelopes.entities.envelope.sender.brand

object

Show child attributes

envelopes.entities.envelope.sender.id

integer

EDI account ID

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

envelopes.entities.envelope.sender.retailer

object

Show child attributes

envelopes.entities.envelope.sender.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

envelopes.entities.envelope.sub_element_delimiter

string

Sub element delimiter

Required string length: 1 - 12

envelopes.entities.envelope.transmitted_at

string | null

Time of envelope transmittance (UTC format)

envelopes.entities.object_id

integer

required

Object ID associated with the content type

Required range: 0 < x < 4294967295

envelopes.entities.id

integer

Envelop entity ID

envelopes.id

integer

Envelop ID

envelopes.receiver

object

Show child attributes

envelopes.receiver.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

envelopes.receiver.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

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

envelopes.receiver.brand.cover_url

string

URL of the cover image

Minimum length: 1

envelopes.receiver.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

envelopes.receiver.brand.id

integer

Vendor (brand) ID

envelopes.receiver.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

envelopes.receiver.brand.is_on_rcn

boolean

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

envelopes.receiver.brand.is_onboarded

boolean

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

envelopes.receiver.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

envelopes.receiver.brand.logo_url

string

URL of the brand logo

Minimum length: 1

envelopes.receiver.brand.name

string

Vendor name

Required string length: 1 - 64

envelopes.receiver.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

envelopes.receiver.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

envelopes.receiver.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

envelopes.receiver.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

envelopes.receiver.brand.subscription_is_delinquent

boolean

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

envelopes.receiver.brand.subscription_is_expired

boolean

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

envelopes.receiver.brand.subscription_is_on_grace_period

boolean

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

envelopes.receiver.brand.website

string | null

URL of brand website

Maximum length: 100

envelopes.receiver.id

integer

EDI account ID

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

envelopes.receiver.retailer

object

Show child attributes

envelopes.receiver.retailer.code

string

required

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

Required string length: 1 - 32

envelopes.receiver.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

envelopes.receiver.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

envelopes.receiver.retailer.id

integer

Retailer ID

envelopes.receiver.retailer.is_onboarded

boolean

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

envelopes.receiver.retailer.is_rcn_retailer

boolean

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

envelopes.receiver.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

envelopes.receiver.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

envelopes.receiver.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

envelopes.receiver.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

envelopes.receiver.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

envelopes.receiver.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

envelopes.receiver.retailer.website

string | null

Website URL

Maximum length: 100

envelopes.receiver.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

envelopes.rejected_at

string | null

Time of envelope rejection (UTC format)

envelopes.request_acknowledgment

boolean

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

envelopes.segment_delimiter

string

Segment delimited

Required string length: 1 - 12

envelopes.sender

object

Show child attributes

envelopes.sender.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

envelopes.sender.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

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

envelopes.sender.brand.cover_url

string

URL of the cover image

Minimum length: 1

envelopes.sender.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

envelopes.sender.brand.id

integer

Vendor (brand) ID

envelopes.sender.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

envelopes.sender.brand.is_on_rcn

boolean

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

envelopes.sender.brand.is_onboarded

boolean

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

envelopes.sender.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

envelopes.sender.brand.logo_url

string

URL of the brand logo

Minimum length: 1

envelopes.sender.brand.name

string

Vendor name

Required string length: 1 - 64

envelopes.sender.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

envelopes.sender.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

envelopes.sender.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

envelopes.sender.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

envelopes.sender.brand.subscription_is_delinquent

boolean

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

envelopes.sender.brand.subscription_is_expired

boolean

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

envelopes.sender.brand.subscription_is_on_grace_period

boolean

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

envelopes.sender.brand.website

string | null

URL of brand website

Maximum length: 100

envelopes.sender.id

integer

EDI account ID

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

envelopes.sender.retailer

object

Show child attributes

envelopes.sender.retailer.code

string

required

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

Required string length: 1 - 32

envelopes.sender.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

envelopes.sender.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

envelopes.sender.retailer.id

integer

Retailer ID

envelopes.sender.retailer.is_onboarded

boolean

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

envelopes.sender.retailer.is_rcn_retailer

boolean

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

envelopes.sender.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

envelopes.sender.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

envelopes.sender.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

envelopes.sender.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

envelopes.sender.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

envelopes.sender.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

envelopes.sender.retailer.website

string | null

Website URL

Maximum length: 100

envelopes.sender.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

envelopes.sub_element_delimiter

string

Sub element delimiter

Required string length: 1 - 12

envelopes.transmitted_at

string | null

Time of envelope transmittance (UTC format)

fill_time

string | null

Fill time

fulfill_by

string

Time when order will be completely fulfilled (UTC format)

fulfilled_at

string | null

Time of order fulfillment (UTC format)

gift_fee

string | null

Gift fee (if applicable)

gift_message

string

Gift message

id

integer

Order ID

invoice_count

integer

Invoice count

invoices

object[]

Show child attributes

invoices.invoice_number

string

required

Invoice number

Required string length: 1 - 32

invoices.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

invoices.allowances

object[]

Show child attributes

invoices.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

invoices.allowances.price

string

required

Allowance price

invoices.allowances.adjustment_code

object

Show child attributes

invoices.allowances.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

invoices.allowances.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

invoices.allowances.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

invoices.allowances.adjustment_code.id

integer

Adjustment ID

invoices.allowances.id

integer

Allowance ID

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

invoices.brand.cover_url

string

URL of the cover image

Minimum length: 1

invoices.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

invoices.brand.id

integer

Vendor (brand) ID

invoices.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

invoices.brand.is_on_rcn

boolean

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

invoices.brand.is_onboarded

boolean

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

invoices.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

invoices.brand.logo_url

string

URL of the brand logo

Minimum length: 1

invoices.brand.name

string

Vendor name

Required string length: 1 - 64

invoices.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

invoices.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

invoices.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

invoices.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

invoices.brand.subscription_is_delinquent

boolean

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

invoices.brand.subscription_is_expired

boolean

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

invoices.brand.subscription_is_on_grace_period

boolean

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

invoices.brand.website

string | null

URL of brand website

Maximum length: 100

invoices.canceled_at

string | null

Time of order cancellation (UTC format)

invoices.charges

object[]

Show child attributes

invoices.charges.description

string

required

Invoice description

Required string length: 1 - 128

invoices.charges.price

string

required

Invoice price

invoices.charges.adjustment_code

object

Show child attributes

invoices.charges.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

invoices.charges.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

invoices.charges.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

invoices.charges.adjustment_code.id

integer

Adjustment ID

invoices.charges.id

integer

Invoice ID

invoices.closed_at

string | null

Time of complete invoice payment (UTC format)

invoices.connection_id

string

Connection ID

invoices.currency

object

Show child attributes

invoices.currency.id

integer

Currency ID

invoices.currency.name

string

Currency name

Maximum length: 200

invoices.currency.symbol

string | null

Currency symbol

Maximum length: 5

invoices.currency.unit

string

Currency unit

invoices.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

invoices.due_amount

string | null

Pending amount

invoices.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

invoices.id

integer

Invoice ID

invoices.invoice_acceptance

object

Show child attributes

invoices.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

invoices.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

invoices.invoice_acceptance.accepted_by.first_name

string | null

First name of user

Maximum length: 64

invoices.invoice_acceptance.accepted_by.id

integer

User ID who accepted or rejected the invoice

invoices.invoice_acceptance.accepted_by.is_me

boolean

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

invoices.invoice_acceptance.accepted_by.last_name

string | null

Last name of user

Maximum length: 64

invoices.invoice_acceptance.accepted_by.photo_url

string

URL of the user photo

Minimum length: 1

invoices.invoice_acceptance.accepted_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

invoices.invoice_acceptance.accepted_by.status

enum<string>

User status

Available options:

active,

invited,

locked

invoices.invoice_acceptance.accepted_by.title

string | null

User title

Maximum length: 64

invoices.invoice_acceptance.accepted_by.type

enum<string>

User type

Available options:

standard,

api

invoices.invoice_acceptance.id

integer

Invoice acceptance ID

invoices.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

invoices.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

invoices.invoice_acceptance.rejected_by

object

Show child attributes

invoices.invoice_acceptance.rejected_by.first_name

string | null

First name of user

Maximum length: 64

invoices.invoice_acceptance.rejected_by.id

integer

User ID who accepted or rejected the invoice

invoices.invoice_acceptance.rejected_by.is_me

boolean

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

invoices.invoice_acceptance.rejected_by.last_name

string | null

Last name of user

Maximum length: 64

invoices.invoice_acceptance.rejected_by.photo_url

string

URL of the user photo

Minimum length: 1

invoices.invoice_acceptance.rejected_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

invoices.invoice_acceptance.rejected_by.status

enum<string>

User status

Available options:

active,

invited,

locked

invoices.invoice_acceptance.rejected_by.title

string | null

User title

Maximum length: 64

invoices.invoice_acceptance.rejected_by.type

enum<string>

User type

Available options:

standard,

api

invoices.invoice_lines

object[]

Show child attributes

invoices.invoice_lines.price

string

required

Discounted price

invoices.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 < x < 2147483647

invoices.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

invoices.invoice_lines.description

string | null

Product description

Maximum length: 128

invoices.invoice_lines.id

integer

Invoice line ID

invoices.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 < x < 2147483647

invoices.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

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

invoices.invoice_lines.name

string | null

Product name

Maximum length: 128

invoices.invoice_lines.retail_price

string

Retail price

invoices.invoice_lines.variant

object

Show child attributes

invoices.invoice_lines.variant.active_permit

object

Show child attributes

invoices.invoice_lines.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

invoices.invoice_lines.variant.active_permit.attributes

object

invoices.invoice_lines.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

invoices.invoice_lines.variant.active_permit.id

integer

Permit ID

invoices.invoice_lines.variant.active_permit.is_acknowledged

boolean

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

invoices.invoice_lines.variant.active_permit.is_in_effect

boolean

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

invoices.invoice_lines.variant.active_permit.pricing

object

invoices.invoice_lines.variant.active_permit.retailer

object

Show child attributes

invoices.invoice_lines.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

invoices.invoice_lines.variant.active_permit.retailer_price

string | null

Retailer price of the variant

invoices.invoice_lines.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

invoices.invoice_lines.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

invoices.invoice_lines.variant.attributes

object[]

Show child attributes

invoices.invoice_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

invoices.invoice_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

invoices.invoice_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

invoices.invoice_lines.variant.attributes.description

string | null

Attribute description

invoices.invoice_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

invoices.invoice_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

invoices.invoice_lines.variant.attributes.id

integer

Attribute ID

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

invoices.invoice_lines.variant.attributes.values

object

Show child attributes

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

invoices.invoice_lines.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

invoices.invoice_lines.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

invoices.invoice_lines.variant.brand.id

integer

Vendor (brand) ID

invoices.invoice_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

invoices.invoice_lines.variant.brand.is_on_rcn

boolean

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

invoices.invoice_lines.variant.brand.is_onboarded

boolean

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

invoices.invoice_lines.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

invoices.invoice_lines.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

invoices.invoice_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

invoices.invoice_lines.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

invoices.invoice_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

invoices.invoice_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

invoices.invoice_lines.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

invoices.invoice_lines.variant.brand.subscription_is_delinquent

boolean

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

invoices.invoice_lines.variant.brand.subscription_is_expired

boolean

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

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

invoices.invoice_lines.variant.brand.website

string | null

URL of brand website

Maximum length: 100

invoices.invoice_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

invoices.invoice_lines.variant.cartons

object[]

Show child attributes

invoices.invoice_lines.variant.cartons.height

string | null

Carton height

invoices.invoice_lines.variant.cartons.height_unit

string

Unit of height

invoices.invoice_lines.variant.cartons.id

integer

Carton ID

invoices.invoice_lines.variant.cartons.length

string | null

Carton length

invoices.invoice_lines.variant.cartons.length_unit

string

Unit of length

invoices.invoice_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

invoices.invoice_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

invoices.invoice_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

invoices.invoice_lines.variant.cartons.weight

string | null

Carton weight

invoices.invoice_lines.variant.cartons.weight_unit

string

Unit of weight

invoices.invoice_lines.variant.cartons.width

string | null

Carton width

invoices.invoice_lines.variant.cartons.width_unit

string

Unit of width

invoices.invoice_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

invoices.invoice_lines.variant.id

integer

Variant ID

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

invoices.invoice_lines.variant.inventory

object

Show child attributes

invoices.invoice_lines.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

invoices.invoice_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

invoices.invoice_lines.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

invoices.invoice_lines.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

invoices.invoice_lines.variant.inventory.sellable_updated_at

string

required

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

invoices.invoice_lines.variant.inventory.discontinued

boolean

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

invoices.invoice_lines.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

invoices.invoice_lines.variant.inventory.inventory

integer

Inventory of variant

invoices.invoice_lines.variant.inventory.locations

object[]

Show child attributes

invoices.invoice_lines.variant.inventory.replenishable

boolean

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

invoices.invoice_lines.variant.inventory.sellable

string

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

invoices.invoice_lines.variant.is_compatible

boolean

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

invoices.invoice_lines.variant.media

object[]

Show child attributes

invoices.invoice_lines.variant.media.created_at

string

Time of variant image creation (UTC format)

invoices.invoice_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

invoices.invoice_lines.variant.media.id

integer

Variant ID

invoices.invoice_lines.variant.media.media

string

Variant images

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

invoices.invoice_lines.variant.media.updated_at

string

Time of variant image update (UTC format)

invoices.invoice_lines.variant.media.url

string

URL of variant image

invoices.invoice_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

invoices.invoice_lines.variant.name

string | null

Variant Name

Maximum length: 200

invoices.invoice_lines.variant.permits

object[]

Show child attributes

invoices.invoice_lines.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

invoices.invoice_lines.variant.permits.attributes

object

invoices.invoice_lines.variant.permits.end_at

string | null

Time of permit end (UTC format)

invoices.invoice_lines.variant.permits.id

integer

Permit ID

invoices.invoice_lines.variant.permits.is_acknowledged

boolean

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

invoices.invoice_lines.variant.permits.is_in_effect

boolean

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

invoices.invoice_lines.variant.permits.pricing

object

invoices.invoice_lines.variant.permits.retailer

object

Show child attributes

invoices.invoice_lines.variant.permits.retailer_cost

string | null

Retailer cost of variant

invoices.invoice_lines.variant.permits.retailer_price

string | null

Retailer price of the variant

invoices.invoice_lines.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

invoices.invoice_lines.variant.permits.start_at

string | null

Time of permit start (UTC format)

invoices.invoice_lines.variant.proposal_variant

object

Show child attributes

invoices.invoice_lines.variant.proposal_variant.approve

boolean

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

invoices.invoice_lines.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

invoices.invoice_lines.variant.proposal_variant.attributes

object[]

Show child attributes

invoices.invoice_lines.variant.proposal_variant.created_at

string

Time of creation (UTC format)

invoices.invoice_lines.variant.proposal_variant.delete

boolean

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

invoices.invoice_lines.variant.proposal_variant.id

integer

Proposal variant ID

invoices.invoice_lines.variant.proposal_variant.issues

object[]

Show child attributes

invoices.invoice_lines.variant.proposal_variant.memos

object[]

Show child attributes

invoices.invoice_lines.variant.proposal_variant.pricing

string

Pricing of variant

invoices.invoice_lines.variant.proposal_variant.reject

boolean

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

invoices.invoice_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

invoices.invoice_lines.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

invoices.invoice_lines.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

invoices.invoice_lines.variant.proposal_variant.variant_id

integer

Variant ID

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

invoices.invoice_lines.variant.retailer_categories.id

integer

Retailer category ID

invoices.invoice_lines.variant.retailer_categories.retailer

object

Show child attributes

invoices.invoice_lines.variant.retailer_identifiers

object

Show child attributes

invoices.invoice_lines.variant.retailer_identifiers.id

integer

Retailer ID

invoices.invoice_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

invoices.invoice_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

invoices.invoice_lines.variant.retailer_identifiers.retailer

object

Show child attributes

invoices.invoice_lines.variant.ruleset_variant_summary

string

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

invoices.invoice_lines.variant.ruleset_variants

object[]

Show child attributes

invoices.invoice_lines.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

invoices.invoice_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

invoices.invoice_lines.variant.ruleset_variants.results

string

Response

invoices.invoice_lines.variant.ruleset_variants.ruleset

object

Show child attributes

invoices.invoice_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

invoices.invoice_lines.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

invoices.invoice_lines.variant.size

string | null

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

Maximum length: 128

invoices.invoice_lines.variant.style

string | null

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

Maximum length: 128

invoices.invoice_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

invoices.invoiced_at

string | null

Time of invoice creation (UTC format)

invoices.net_amount

string | null

Total invoice amount (exluding taxes)

invoices.notes

string | null

Addition info adding to shipping

invoices.order_id

integer

Order ID related to invoice

invoices.ordered_at

string | null

Time of order finalization (UTC format)

invoices.paid_at

string | null

Time of payment (UTC format)

invoices.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

invoices.remit_to

object

Show child attributes

invoices.remit_to.city

string

required

City name

Required string length: 1 - 64

invoices.remit_to.country

string

required

Country name

Required string length: 1 - 128

invoices.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

invoices.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

invoices.remit_to.province

string

required

State name

Required string length: 1 - 32

invoices.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

invoices.remit_to.email

string | null

Contact email address

Maximum length: 128

invoices.remit_to.fax

string | null

Fax number

Maximum length: 32

invoices.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

invoices.remit_to.id

integer

Address ID

invoices.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

invoices.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

invoices.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

invoices.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

invoices.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

invoices.retailer

object

Show child attributes

invoices.retailer.code

string

required

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

Required string length: 1 - 32

invoices.retailer.name

string

required

Retailer name

Required string length: 1 - 64

invoices.retailer.brand_permit_creation_allowed

boolean

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

invoices.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

invoices.retailer.id

integer

Retailer ID

invoices.retailer.is_onboarded

boolean

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

invoices.retailer.is_rcn_retailer

boolean

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

invoices.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

invoices.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

invoices.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

invoices.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

invoices.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

invoices.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

invoices.retailer.website

string | null

Website URL

Maximum length: 100

invoices.ship_from

object

Show child attributes

invoices.ship_from.city

string

required

City name

Required string length: 1 - 64

invoices.ship_from.country

string

required

Country name

Required string length: 1 - 128

invoices.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

invoices.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

invoices.ship_from.province

string

required

State name

Required string length: 1 - 32

invoices.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

invoices.ship_from.email

string | null

Contact email address

Maximum length: 128

invoices.ship_from.fax

string | null

Fax number

Maximum length: 32

invoices.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

invoices.ship_from.id

integer

Address ID

invoices.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

invoices.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

invoices.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

invoices.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

invoices.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

invoices.ship_to

object

Show child attributes

invoices.ship_to.city

string

required

City name

Required string length: 1 - 64

invoices.ship_to.country

string

required

Country name

Required string length: 1 - 128

invoices.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

invoices.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

invoices.ship_to.province

string

required

State name

Required string length: 1 - 32

invoices.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

invoices.ship_to.email

string | null

Contact email address

Maximum length: 128

invoices.ship_to.fax

string | null

Fax number

Maximum length: 32

invoices.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

invoices.ship_to.id

integer

Address ID

invoices.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

invoices.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

invoices.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

invoices.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

invoices.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

invoices.shipped_at

string | null

Time of shipping (UTC format)

invoices.shipping_account_number

string | null

Shipping account number

Maximum length: 32

invoices.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

invoices.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

invoices.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

invoices.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

invoices.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

invoices.shipping_weight

string | null

Shipping weight

invoices.sold_to

object

Show child attributes

invoices.sold_to.city

string

required

City name

Required string length: 1 - 64

invoices.sold_to.country

string

required

Country name

Required string length: 1 - 128

invoices.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

invoices.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

invoices.sold_to.province

string

required

State name

Required string length: 1 - 32

invoices.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

invoices.sold_to.email

string | null

Contact email address

Maximum length: 128

invoices.sold_to.fax

string | null

Fax number

Maximum length: 32

invoices.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

invoices.sold_to.id

integer

Address ID

invoices.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

invoices.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

invoices.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

invoices.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

invoices.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

invoices.status

enum<string>

Invoice status

Available options:

closed,

open

invoices.subtotal

string | null

Sub-total

invoices.tax

string | null

Total tax on the invoice

invoices.terms_date_due

string | null

Payment expected date

invoices.terms_description

string | null

Description of invoice terms

invoices.terms_discount_percent

string | null

Discount percentage on selected term

invoices.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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

is_acknowledged

boolean

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

is_gift

boolean

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

is_on_hold

boolean

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

is_priority

boolean

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

is_replacement

boolean

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

memos

object[]

Show child attributes

memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

memos.created_at

string

Time of memo creation (UTC format)

memos.created_by

object

Show child attributes

memos.created_by.first_name

string | null

First name of user

Maximum length: 64

memos.created_by.id

integer

User ID who accepted or rejected the invoice

memos.created_by.is_me

boolean

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

memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

memos.created_by.title

string | null

User title

Maximum length: 64

memos.created_by.type

enum<string>

User type

Available options:

standard,

api

memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

memos.id

integer

Memo ID

memos.notify_people

boolean

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

memos.text

string

Memo text

memos.updated_at

string

Time of memo update (UTC format)

memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

memos_count

integer

Total memos

metadata

object[]

Show child attributes

metadata.created_at

string

Time of metadata creation (UTC format)

metadata.id

integer

Metadata ID

metadata.name

string

Metadata name

Minimum length: 1

metadata.type

string

Metadata type such as integer, float, etc.

Minimum length: 1

metadata.value

string | null

Metadata value, depending on the type

on_hold_at

string | null

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

on_hold_until

string | null

Date till when the order will be on hold

order_batches

object[]

Show child attributes

order_batches.id

integer

Batch ID of order

order_lines

object[]

Show child attributes

order_lines.ordered_at

string

required

Time of order finalization (UTC format)

order_lines.quantity

integer

required

Total products in the order

order_lines.backordered_until

string

Time till when product is backordered (UTC format)

order_lines.canceled_at

string | null

Time of cancellation (UTC format)

order_lines.estimated_price

string | null

Estimated price

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.

order_lines.gift_fee

string | null

Gift fee

order_lines.id

integer

Order line ID

order_lines.metadata

object[]

Show child attributes

order_lines.metadata.created_at

string

Time of metadata creation (UTC format)

order_lines.metadata.id

integer

Metadata ID

order_lines.metadata.name

string

Metadata name

Minimum length: 1

order_lines.metadata.type

string

Metadata type such as integer, float, etc.

Minimum length: 1

order_lines.metadata.value

string | null

Metadata value, depending on the type

order_lines.net_price

string

Net price

order_lines.order_line_number

string

Order line number (auto-incremental number)

order_lines.packages_per_quantity

integer

Number of packages per quantity

order_lines.price

string

Discounted price

order_lines.quantity_canceled

string

Quantity cancelled

order_lines.quantity_invoiced

integer

Quantity invoiced

order_lines.quantity_open

integer

Quantity to be shipped

order_lines.quantity_returned

integer

Quantity returned

order_lines.quantity_shipped

integer

Quantity shipped

order_lines.shipping_charged

string

Shipping cost

order_lines.status

string

Order status

Minimum length: 1

order_lines.subtotal

string

Subtotal amount

order_lines.subtotal_charged

string

Subtotal charged

order_lines.tax_charged

string

Tax charged

order_lines.total_charge

string

Total charge

order_lines.variant

string

Details of product variant

pickup_on

string | null

Time of when order was picked up (UTC format)

priority_user

object

Show child attributes

priority_user.first_name

string | null

First name of user

Maximum length: 64

priority_user.id

integer

User ID who accepted or rejected the invoice

priority_user.is_me

boolean

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

priority_user.last_name

string | null

Last name of user

Maximum length: 64

priority_user.photo_url

string

URL of the user photo

Minimum length: 1

priority_user.profile_photo

string

URL of the user's profile photo

Minimum length: 1

priority_user.status

enum<string>

User status

Available options:

active,

invited,

locked

priority_user.title

string | null

User title

Maximum length: 64

priority_user.type

enum<string>

User type

Available options:

standard,

api

received_at

string

Time of when order was received (UTC format)

requested_shipping_method

object

Show child attributes

requested_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

requested_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

requested_shipping_method.id

integer

ID of shipping method

requested_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

requested_shipping_method_id

integer

ID of the requested shipping method

retailer

object

Show child attributes

retailer.code

string

required

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

Required string length: 1 - 32

retailer.name

string

required

Retailer name

Required string length: 1 - 64

retailer.brand_permit_creation_allowed

boolean

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

retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

retailer.id

integer

Retailer ID

retailer.is_onboarded

boolean

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

retailer.is_rcn_retailer

boolean

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

retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

retailer.logo_url

string

URL of retailer logo

Minimum length: 1

retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

retailer.website

string | null

Website URL

Maximum length: 100

retailer_order_number

string

Retailer order number

Minimum length: 1

return_to

object

Show child attributes

return_to.city

string

required

City name

Required string length: 1 - 64

return_to.country

string

required

Country name

Required string length: 1 - 128

return_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

return_to.postal_code

string

required

Postal code

Required string length: 1 - 32

return_to.province

string

required

State name

Required string length: 1 - 32

return_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

return_to.email

string | null

Contact email address

Maximum length: 128

return_to.fax

string | null

Fax number

Maximum length: 32

return_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

return_to.id

integer

Address ID

return_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

return_to.phone1

string | null

Primary contact number

Maximum length: 32

return_to.phone2

string | null

Alternate contact number

Maximum length: 32

return_to.street2

string | null

Line 2 of the address

Maximum length: 128

return_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

rmas

object[]

Show child attributes

rmas.order_id

integer

required

Order ID

rmas.reason_id

integer

required

ID associated with return reason

rmas.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

rmas.approved_at

string | null

Time of RMA approval (UTC format)

rmas.attachments

object[]

Show child attributes

rmas.attachments.content_type

integer

Content type

rmas.attachments.file

string | null

File name

rmas.attachments.filename

string | null

File name used for sharing

Maximum length: 255

rmas.attachments.id

integer

Attachment or document ID

rmas.attachments.object_id

integer

Attachement object ID

rmas.attachments.original_filename

string | null

Original file name

Maximum length: 255

rmas.attachments.tags

object[]

Show child attributes

rmas.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

rmas.attachments.tags.id

integer

Attachment tag ID

rmas.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

rmas.attachments.url

string

URL of attachment

Minimum length: 1

rmas.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

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

rmas.brand.cover_url

string

URL of the cover image

Minimum length: 1

rmas.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

rmas.brand.id

integer

Vendor (brand) ID

rmas.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

rmas.brand.is_on_rcn

boolean

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

rmas.brand.is_onboarded

boolean

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

rmas.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

rmas.brand.logo_url

string

URL of the brand logo

Minimum length: 1

rmas.brand.name

string

Vendor name

Required string length: 1 - 64

rmas.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

rmas.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

rmas.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

rmas.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

rmas.brand.subscription_is_delinquent

boolean

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

rmas.brand.subscription_is_expired

boolean

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

rmas.brand.subscription_is_on_grace_period

boolean

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

rmas.brand.website

string | null

URL of brand website

Maximum length: 100

rmas.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

rmas.credits

object[]

Show child attributes

rmas.credits.acknowledged_at

string | null

Time of credit acknowledgement

rmas.credits.adjustments

object[]

Show child attributes

rmas.credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

rmas.credits.adjustments.id

integer

Adjustment ID

rmas.credits.adjustments.net_price

string

Adjustment net price

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

rmas.credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

rmas.credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

rmas.credits.brand.id

integer

Vendor (brand) ID

rmas.credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

rmas.credits.brand.is_on_rcn

boolean

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

rmas.credits.brand.is_onboarded

boolean

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

rmas.credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

rmas.credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

rmas.credits.brand.name

string

Vendor name

Required string length: 1 - 64

rmas.credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

rmas.credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

rmas.credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

rmas.credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

rmas.credits.brand.subscription_is_delinquent

boolean

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

rmas.credits.brand.subscription_is_expired

boolean

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

rmas.credits.brand.subscription_is_on_grace_period

boolean

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

rmas.credits.brand.website

string | null

URL of brand website

Maximum length: 100

rmas.credits.created_at

string

Time of creation (UTC format)

rmas.credits.credit_amount

string

Credit amount

rmas.credits.credit_lines

object[]

Show child attributes

rmas.credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 < x < 2147483647

rmas.credits.credit_lines.id

integer

Credit line ID

rmas.credits.credit_lines.net_price

string

Credit line net price

rmas.credits.credit_lines.variant

object

Show child attributes

rmas.credits.credit_lines.variant.active_permit

object

Show child attributes

rmas.credits.credit_lines.variant.attributes

object[]

Show child attributes

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

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

rmas.credits.credit_lines.variant.id

integer

Variant ID

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

rmas.credits.credit_lines.variant.inventory

object

Show child attributes

rmas.credits.credit_lines.variant.is_compatible

boolean

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

rmas.credits.credit_lines.variant.media

object[]

Show child attributes

rmas.credits.credit_lines.variant.name

string | null

Variant Name

Maximum length: 200

rmas.credits.credit_lines.variant.permits

object[]

Show child attributes

rmas.credits.credit_lines.variant.proposal_variant

object

Show child attributes

rmas.credits.credit_lines.variant.retailer_categories

object

Show child attributes

rmas.credits.credit_lines.variant.retailer_identifiers

object

Show child attributes

rmas.credits.credit_lines.variant.ruleset_variant_summary

string

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

rmas.credits.credit_lines.variant.ruleset_variants

object[]

Show child attributes

rmas.credits.credit_lines.variant.size

string | null

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

Maximum length: 128

rmas.credits.credit_lines.variant.style

string | null

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

Maximum length: 128

rmas.credits.credit_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

rmas.credits.credit_number

string | null

Credit number

Maximum length: 32

rmas.credits.credited_at

string | null

Time of credit (UTC format)

rmas.credits.currency

object

Show child attributes

rmas.credits.currency.id

integer

Currency ID

rmas.credits.currency.name

string

Currency name

Maximum length: 200

rmas.credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

rmas.credits.currency.unit

string

Currency unit

rmas.credits.id

integer

Credit ID

rmas.credits.invoice

object

Show child attributes

rmas.credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

rmas.credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

rmas.credits.invoice.allowances

object[]

Show child attributes

rmas.credits.invoice.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

rmas.credits.invoice.allowances.price

string

required

Allowance price

rmas.credits.invoice.allowances.adjustment_code

object

Show child attributes

rmas.credits.invoice.allowances.id

integer

Allowance ID

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

rmas.credits.invoice.brand.cover_url

string

URL of the cover image

Minimum length: 1

rmas.credits.invoice.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

rmas.credits.invoice.brand.id

integer

Vendor (brand) ID

rmas.credits.invoice.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

rmas.credits.invoice.brand.is_on_rcn

boolean

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

rmas.credits.invoice.brand.is_onboarded

boolean

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

rmas.credits.invoice.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

rmas.credits.invoice.brand.logo_url

string

URL of the brand logo

Minimum length: 1

rmas.credits.invoice.brand.name

string

Vendor name

Required string length: 1 - 64

rmas.credits.invoice.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

rmas.credits.invoice.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

rmas.credits.invoice.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

rmas.credits.invoice.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

rmas.credits.invoice.brand.subscription_is_delinquent

boolean

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

rmas.credits.invoice.brand.subscription_is_expired

boolean

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

rmas.credits.invoice.brand.subscription_is_on_grace_period

boolean

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

rmas.credits.invoice.brand.website

string | null

URL of brand website

Maximum length: 100

rmas.credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

rmas.credits.invoice.charges

object[]

Show child attributes

rmas.credits.invoice.charges.description

string

required

Invoice description

Required string length: 1 - 128

rmas.credits.invoice.charges.price

string

required

Invoice price

rmas.credits.invoice.charges.adjustment_code

object

Show child attributes

rmas.credits.invoice.charges.id

integer

Invoice ID

rmas.credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

rmas.credits.invoice.connection_id

string

Connection ID

rmas.credits.invoice.currency

object

Show child attributes

rmas.credits.invoice.currency.id

integer

Currency ID

rmas.credits.invoice.currency.name

string

Currency name

Maximum length: 200

rmas.credits.invoice.currency.symbol

string | null

Currency symbol

Maximum length: 5

rmas.credits.invoice.currency.unit

string

Currency unit

rmas.credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

rmas.credits.invoice.due_amount

string | null

Pending amount

rmas.credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

rmas.credits.invoice.id

integer

Invoice ID

rmas.credits.invoice.invoice_acceptance

object

Show child attributes

rmas.credits.invoice.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

rmas.credits.invoice.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

rmas.credits.invoice.invoice_acceptance.id

integer

Invoice acceptance ID

rmas.credits.invoice.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

rmas.credits.invoice.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

rmas.credits.invoice.invoice_acceptance.rejected_by

object

Show child attributes

rmas.credits.invoice.invoice_lines

object[]

Show child attributes

rmas.credits.invoice.invoice_lines.price

string

required

Discounted price

rmas.credits.invoice.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 < x < 2147483647

rmas.credits.invoice.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

rmas.credits.invoice.invoice_lines.description

string | null

Product description

Maximum length: 128

rmas.credits.invoice.invoice_lines.id

integer

Invoice line ID

rmas.credits.invoice.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 < x < 2147483647

rmas.credits.invoice.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

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

rmas.credits.invoice.invoice_lines.name

string | null

Product name

Maximum length: 128

rmas.credits.invoice.invoice_lines.retail_price

string

Retail price

rmas.credits.invoice.invoice_lines.variant

object

Show child attributes

rmas.credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

rmas.credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

rmas.credits.invoice.notes

string | null

Addition info adding to shipping

rmas.credits.invoice.order_id

integer

Order ID related to invoice

rmas.credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

rmas.credits.invoice.paid_at

string | null

Time of payment (UTC format)

rmas.credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

rmas.credits.invoice.remit_to

object

Show child attributes

rmas.credits.invoice.remit_to.city

string

required

City name

Required string length: 1 - 64

rmas.credits.invoice.remit_to.country

string

required

Country name

Required string length: 1 - 128

rmas.credits.invoice.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

rmas.credits.invoice.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

rmas.credits.invoice.remit_to.province

string

required

State name

Required string length: 1 - 32

rmas.credits.invoice.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

rmas.credits.invoice.remit_to.email

string | null

Contact email address

Maximum length: 128

rmas.credits.invoice.remit_to.fax

string | null

Fax number

Maximum length: 32

rmas.credits.invoice.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

rmas.credits.invoice.remit_to.id

integer

Address ID

rmas.credits.invoice.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

rmas.credits.invoice.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

rmas.credits.invoice.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

rmas.credits.invoice.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

rmas.credits.invoice.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

rmas.credits.invoice.retailer

object

Show child attributes

rmas.credits.invoice.retailer.code

string

required

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

Required string length: 1 - 32

rmas.credits.invoice.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

rmas.credits.invoice.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

rmas.credits.invoice.retailer.id

integer

Retailer ID

rmas.credits.invoice.retailer.is_onboarded

boolean

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

rmas.credits.invoice.retailer.is_rcn_retailer

boolean

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

rmas.credits.invoice.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

rmas.credits.invoice.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

rmas.credits.invoice.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

rmas.credits.invoice.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

rmas.credits.invoice.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

rmas.credits.invoice.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

rmas.credits.invoice.retailer.website

string | null

Website URL

Maximum length: 100

rmas.credits.invoice.ship_from

object

Show child attributes

rmas.credits.invoice.ship_from.city

string

required

City name

Required string length: 1 - 64

rmas.credits.invoice.ship_from.country

string

required

Country name

Required string length: 1 - 128

rmas.credits.invoice.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

rmas.credits.invoice.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

rmas.credits.invoice.ship_from.province

string

required

State name

Required string length: 1 - 32

rmas.credits.invoice.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

rmas.credits.invoice.ship_from.email

string | null

Contact email address

Maximum length: 128

rmas.credits.invoice.ship_from.fax

string | null

Fax number

Maximum length: 32

rmas.credits.invoice.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

rmas.credits.invoice.ship_from.id

integer

Address ID

rmas.credits.invoice.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

rmas.credits.invoice.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

rmas.credits.invoice.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

rmas.credits.invoice.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

rmas.credits.invoice.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

rmas.credits.invoice.ship_to

object

Show child attributes

rmas.credits.invoice.ship_to.city

string

required

City name

Required string length: 1 - 64

rmas.credits.invoice.ship_to.country

string

required

Country name

Required string length: 1 - 128

rmas.credits.invoice.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

rmas.credits.invoice.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

rmas.credits.invoice.ship_to.province

string

required

State name

Required string length: 1 - 32

rmas.credits.invoice.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

rmas.credits.invoice.ship_to.email

string | null

Contact email address

Maximum length: 128

rmas.credits.invoice.ship_to.fax

string | null

Fax number

Maximum length: 32

rmas.credits.invoice.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

rmas.credits.invoice.ship_to.id

integer

Address ID

rmas.credits.invoice.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

rmas.credits.invoice.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

rmas.credits.invoice.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

rmas.credits.invoice.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

rmas.credits.invoice.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

rmas.credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

rmas.credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

rmas.credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

rmas.credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

rmas.credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

rmas.credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

rmas.credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

rmas.credits.invoice.shipping_weight

string | null

Shipping weight

rmas.credits.invoice.sold_to

object

Show child attributes

rmas.credits.invoice.sold_to.city

string

required

City name

Required string length: 1 - 64

rmas.credits.invoice.sold_to.country

string

required

Country name

Required string length: 1 - 128

rmas.credits.invoice.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

rmas.credits.invoice.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

rmas.credits.invoice.sold_to.province

string

required

State name

Required string length: 1 - 32

rmas.credits.invoice.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

rmas.credits.invoice.sold_to.email

string | null

Contact email address

Maximum length: 128

rmas.credits.invoice.sold_to.fax

string | null

Fax number

Maximum length: 32

rmas.credits.invoice.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

rmas.credits.invoice.sold_to.id

integer

Address ID

rmas.credits.invoice.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

rmas.credits.invoice.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

rmas.credits.invoice.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

rmas.credits.invoice.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

rmas.credits.invoice.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

rmas.credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

rmas.credits.invoice.subtotal

string | null

Sub-total

rmas.credits.invoice.tax

string | null

Total tax on the invoice

rmas.credits.invoice.terms_date_due

string | null

Payment expected date

rmas.credits.invoice.terms_description

string | null

Description of invoice terms

rmas.credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

rmas.credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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

rmas.credits.order

string

Order details

rmas.credits.retailer

object

Show child attributes

rmas.credits.retailer.code

string

required

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

Required string length: 1 - 32

rmas.credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

rmas.credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

rmas.credits.retailer.id

integer

Retailer ID

rmas.credits.retailer.is_onboarded

boolean

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

rmas.credits.retailer.is_rcn_retailer

boolean

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

rmas.credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

rmas.credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

rmas.credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

rmas.credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

rmas.credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

rmas.credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

rmas.credits.retailer.website

string | null

Website URL

Maximum length: 100

rmas.credits.rma

object

Show child attributes

rmas.credits.rma.order_id

integer

required

Order ID

rmas.credits.rma.reason_id

integer

required

ID associated with return reason

rmas.credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

rmas.credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

rmas.credits.rma.attachments

object[]

Show child attributes

rmas.credits.rma.attachments.content_type

integer

Content type

rmas.credits.rma.attachments.file

string | null

File name

rmas.credits.rma.attachments.filename

string | null

File name used for sharing

Maximum length: 255

rmas.credits.rma.attachments.id

integer

Attachment or document ID

rmas.credits.rma.attachments.object_id

integer

Attachement object ID

rmas.credits.rma.attachments.original_filename

string | null

Original file name

Maximum length: 255

rmas.credits.rma.attachments.tags

object[]

Show child attributes

rmas.credits.rma.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

rmas.credits.rma.attachments.url

string

URL of attachment

Minimum length: 1

rmas.credits.rma.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

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

rmas.credits.rma.brand.cover_url

string

URL of the cover image

Minimum length: 1

rmas.credits.rma.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

rmas.credits.rma.brand.id

integer

Vendor (brand) ID

rmas.credits.rma.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

rmas.credits.rma.brand.is_on_rcn

boolean

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

rmas.credits.rma.brand.is_onboarded

boolean

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

rmas.credits.rma.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

rmas.credits.rma.brand.logo_url

string

URL of the brand logo

Minimum length: 1

rmas.credits.rma.brand.name

string

Vendor name

Required string length: 1 - 64

rmas.credits.rma.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

rmas.credits.rma.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

rmas.credits.rma.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

rmas.credits.rma.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

rmas.credits.rma.brand.subscription_is_delinquent

boolean

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

rmas.credits.rma.brand.subscription_is_expired

boolean

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

rmas.credits.rma.brand.subscription_is_on_grace_period

boolean

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

rmas.credits.rma.brand.website

string | null

URL of brand website

Maximum length: 100

rmas.credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

rmas.credits.rma.credits

object[]

Show child attributes

rmas.credits.rma.credits.acknowledged_at

string | null

Time of credit acknowledgement

rmas.credits.rma.credits.adjustments

object[]

Show child attributes

rmas.credits.rma.credits.brand

object

Show child attributes

rmas.credits.rma.credits.created_at

string

Time of creation (UTC format)

rmas.credits.rma.credits.credit_amount

string

Credit amount

rmas.credits.rma.credits.credit_lines

object[]

Show child attributes

rmas.credits.rma.credits.credit_number

string | null

Credit number

Maximum length: 32

rmas.credits.rma.credits.credited_at

string | null

Time of credit (UTC format)

rmas.credits.rma.credits.currency

object

Show child attributes

rmas.credits.rma.credits.id

integer

Credit ID

rmas.credits.rma.credits.invoice

object

Show child attributes

rmas.credits.rma.credits.order

string

Order details

rmas.credits.rma.credits.retailer

object

Show child attributes

rmas.credits.rma.credits.rma

object

Show child attributes

rmas.credits.rma.credits.subtotal

string

Subtotal amount

rmas.credits.rma.currency

object

Show child attributes

rmas.credits.rma.currency.id

integer

Currency ID

rmas.credits.rma.currency.name

string

Currency name

Maximum length: 200

rmas.credits.rma.currency.symbol

string | null

Currency symbol

Maximum length: 5

rmas.credits.rma.currency.unit

string

Currency unit

rmas.credits.rma.id

integer

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

rmas.credits.rma.memos

object[]

Show child attributes

rmas.credits.rma.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

rmas.credits.rma.memos.created_at

string

Time of memo creation (UTC format)

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

rmas.credits.rma.memos.id

integer

Memo ID

rmas.credits.rma.memos.notify_people

boolean

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

rmas.credits.rma.memos.text

string

Memo text

rmas.credits.rma.memos.updated_at

string

Time of memo update (UTC format)

rmas.credits.rma.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

rmas.credits.rma.ordered_at

string

Time of order finalization (UTC format)

rmas.credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

rmas.credits.rma.reason

string

Reason for return

Minimum length: 1

rmas.credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

rmas.credits.rma.retailer

object

Show child attributes

rmas.credits.rma.retailer.code

string

required

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

Required string length: 1 - 32

rmas.credits.rma.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

rmas.credits.rma.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

rmas.credits.rma.retailer.id

integer

Retailer ID

rmas.credits.rma.retailer.is_onboarded

boolean

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

rmas.credits.rma.retailer.is_rcn_retailer

boolean

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

rmas.credits.rma.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

rmas.credits.rma.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

rmas.credits.rma.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

rmas.credits.rma.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

rmas.credits.rma.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

rmas.credits.rma.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

rmas.credits.rma.retailer.website

string | null

Website URL

Maximum length: 100

rmas.credits.rma.rma_lines

object[]

Show child attributes

rmas.credits.rma.rma_lines.id

integer

RMA line ID

rmas.credits.rma.rma_lines.net_price

string

Net price

rmas.credits.rma.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 < x < 2147483647

rmas.credits.rma.rma_lines.quantity_shipped

integer

Quantity shipped

rmas.credits.rma.rma_lines.variant

object

Show child attributes

rmas.credits.rma.rma_number

string | null

RMA number

Maximum length: 32

rmas.credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

rmas.credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

rmas.credits.rma.total_amount

string

Total amount

rmas.credits.subtotal

string

Subtotal amount

rmas.currency

object

Show child attributes

rmas.currency.id

integer

Currency ID

rmas.currency.name

string

Currency name

Maximum length: 200

rmas.currency.symbol

string | null

Currency symbol

Maximum length: 5

rmas.currency.unit

string

Currency unit

rmas.id

integer

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

rmas.memos

object[]

Show child attributes

rmas.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

rmas.memos.created_at

string

Time of memo creation (UTC format)

rmas.memos.created_by

object

Show child attributes

rmas.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

rmas.memos.created_by.id

integer

User ID who accepted or rejected the invoice

rmas.memos.created_by.is_me

boolean

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

rmas.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

rmas.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

rmas.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

rmas.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

rmas.memos.created_by.title

string | null

User title

Maximum length: 64

rmas.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

rmas.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

rmas.memos.id

integer

Memo ID

rmas.memos.notify_people

boolean

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

rmas.memos.text

string

Memo text

rmas.memos.updated_at

string

Time of memo update (UTC format)

rmas.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

rmas.ordered_at

string

Time of order finalization (UTC format)

rmas.purchase_order_number

string

Purchase order number

Minimum length: 1

rmas.reason

string

Reason for return

Minimum length: 1

rmas.rejected_at

string | null

Time of RMA rejection(UTC format)

rmas.retailer

object

Show child attributes

rmas.retailer.code

string

required

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

Required string length: 1 - 32

rmas.retailer.name

string

required

Retailer name

Required string length: 1 - 64

rmas.retailer.brand_permit_creation_allowed

boolean

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

rmas.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

rmas.retailer.id

integer

Retailer ID

rmas.retailer.is_onboarded

boolean

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

rmas.retailer.is_rcn_retailer

boolean

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

rmas.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

rmas.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

rmas.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

rmas.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

rmas.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

rmas.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

rmas.retailer.website

string | null

Website URL

Maximum length: 100

rmas.rma_lines

object[]

Show child attributes

rmas.rma_lines.id

integer

RMA line ID

rmas.rma_lines.net_price

string

Net price

rmas.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 < x < 2147483647

rmas.rma_lines.quantity_shipped

integer

Quantity shipped

rmas.rma_lines.variant

object

Show child attributes

rmas.rma_lines.variant.active_permit

object

Show child attributes

rmas.rma_lines.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

rmas.rma_lines.variant.active_permit.attributes

object

rmas.rma_lines.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

rmas.rma_lines.variant.active_permit.id

integer

Permit ID

rmas.rma_lines.variant.active_permit.is_acknowledged

boolean

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

rmas.rma_lines.variant.active_permit.is_in_effect

boolean

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

rmas.rma_lines.variant.active_permit.pricing

object

rmas.rma_lines.variant.active_permit.retailer

object

Show child attributes

rmas.rma_lines.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

rmas.rma_lines.variant.active_permit.retailer_price

string | null

Retailer price of the variant

rmas.rma_lines.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

rmas.rma_lines.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

rmas.rma_lines.variant.attributes

object[]

Show child attributes

rmas.rma_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

rmas.rma_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

rmas.rma_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

rmas.rma_lines.variant.attributes.description

string | null

Attribute description

rmas.rma_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

rmas.rma_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

rmas.rma_lines.variant.attributes.id

integer

Attribute ID

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

rmas.rma_lines.variant.attributes.values

object

Show child attributes

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

rmas.rma_lines.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

rmas.rma_lines.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

rmas.rma_lines.variant.brand.id

integer

Vendor (brand) ID

rmas.rma_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

rmas.rma_lines.variant.brand.is_on_rcn

boolean

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

rmas.rma_lines.variant.brand.is_onboarded

boolean

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

rmas.rma_lines.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

rmas.rma_lines.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

rmas.rma_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

rmas.rma_lines.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

rmas.rma_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

rmas.rma_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

rmas.rma_lines.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

rmas.rma_lines.variant.brand.subscription_is_delinquent

boolean

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

rmas.rma_lines.variant.brand.subscription_is_expired

boolean

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

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

rmas.rma_lines.variant.brand.website

string | null

URL of brand website

Maximum length: 100

rmas.rma_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

rmas.rma_lines.variant.cartons

object[]

Show child attributes

rmas.rma_lines.variant.cartons.height

string | null

Carton height

rmas.rma_lines.variant.cartons.height_unit

string

Unit of height

rmas.rma_lines.variant.cartons.id

integer

Carton ID

rmas.rma_lines.variant.cartons.length

string | null

Carton length

rmas.rma_lines.variant.cartons.length_unit

string

Unit of length

rmas.rma_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

rmas.rma_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

rmas.rma_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

rmas.rma_lines.variant.cartons.weight

string | null

Carton weight

rmas.rma_lines.variant.cartons.weight_unit

string

Unit of weight

rmas.rma_lines.variant.cartons.width

string | null

Carton width

rmas.rma_lines.variant.cartons.width_unit

string

Unit of width

rmas.rma_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

rmas.rma_lines.variant.id

integer

Variant ID

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

rmas.rma_lines.variant.inventory

object

Show child attributes

rmas.rma_lines.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

rmas.rma_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

rmas.rma_lines.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

rmas.rma_lines.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

rmas.rma_lines.variant.inventory.sellable_updated_at

string

required

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

rmas.rma_lines.variant.inventory.discontinued

boolean

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

rmas.rma_lines.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

rmas.rma_lines.variant.inventory.inventory

integer

Inventory of variant

rmas.rma_lines.variant.inventory.locations

object[]

Show child attributes

rmas.rma_lines.variant.inventory.replenishable

boolean

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

rmas.rma_lines.variant.inventory.sellable

string

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

rmas.rma_lines.variant.is_compatible

boolean

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

rmas.rma_lines.variant.media

object[]

Show child attributes

rmas.rma_lines.variant.media.created_at

string

Time of variant image creation (UTC format)

rmas.rma_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

rmas.rma_lines.variant.media.id

integer

Variant ID

rmas.rma_lines.variant.media.media

string

Variant images

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

rmas.rma_lines.variant.media.updated_at

string

Time of variant image update (UTC format)

rmas.rma_lines.variant.media.url

string

URL of variant image

rmas.rma_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

rmas.rma_lines.variant.name

string | null

Variant Name

Maximum length: 200

rmas.rma_lines.variant.permits

object[]

Show child attributes

rmas.rma_lines.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

rmas.rma_lines.variant.permits.attributes

object

rmas.rma_lines.variant.permits.end_at

string | null

Time of permit end (UTC format)

rmas.rma_lines.variant.permits.id

integer

Permit ID

rmas.rma_lines.variant.permits.is_acknowledged

boolean

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

rmas.rma_lines.variant.permits.is_in_effect

boolean

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

rmas.rma_lines.variant.permits.pricing

object

rmas.rma_lines.variant.permits.retailer

object

Show child attributes

rmas.rma_lines.variant.permits.retailer_cost

string | null

Retailer cost of variant

rmas.rma_lines.variant.permits.retailer_price

string | null

Retailer price of the variant

rmas.rma_lines.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

rmas.rma_lines.variant.permits.start_at

string | null

Time of permit start (UTC format)

rmas.rma_lines.variant.proposal_variant

object

Show child attributes

rmas.rma_lines.variant.proposal_variant.approve

boolean

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

rmas.rma_lines.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

rmas.rma_lines.variant.proposal_variant.attributes

object[]

Show child attributes

rmas.rma_lines.variant.proposal_variant.created_at

string

Time of creation (UTC format)

rmas.rma_lines.variant.proposal_variant.delete

boolean

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

rmas.rma_lines.variant.proposal_variant.id

integer

Proposal variant ID

rmas.rma_lines.variant.proposal_variant.issues

object[]

Show child attributes

rmas.rma_lines.variant.proposal_variant.memos

object[]

Show child attributes

rmas.rma_lines.variant.proposal_variant.pricing

string

Pricing of variant

rmas.rma_lines.variant.proposal_variant.reject

boolean

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

rmas.rma_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

rmas.rma_lines.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

rmas.rma_lines.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

rmas.rma_lines.variant.proposal_variant.variant_id

integer

Variant ID

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

rmas.rma_lines.variant.retailer_categories.id

integer

Retailer category ID

rmas.rma_lines.variant.retailer_categories.retailer

object

Show child attributes

rmas.rma_lines.variant.retailer_identifiers

object

Show child attributes

rmas.rma_lines.variant.retailer_identifiers.id

integer

Retailer ID

rmas.rma_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

rmas.rma_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

rmas.rma_lines.variant.retailer_identifiers.retailer

object

Show child attributes

rmas.rma_lines.variant.ruleset_variant_summary

string

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

rmas.rma_lines.variant.ruleset_variants

object[]

Show child attributes

rmas.rma_lines.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

rmas.rma_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

rmas.rma_lines.variant.ruleset_variants.results

string

Response

rmas.rma_lines.variant.ruleset_variants.ruleset

object

Show child attributes

rmas.rma_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

rmas.rma_lines.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

rmas.rma_lines.variant.size

string | null

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

Maximum length: 128

rmas.rma_lines.variant.style

string | null

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

Maximum length: 128

rmas.rma_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

rmas.rma_number

string | null

RMA number

Maximum length: 32

rmas.rmad_at

string | null

Time of RMA creation (UTC format)

rmas.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

rmas.total_amount

string

Total amount

ship_from

object

Show child attributes

ship_from.city

string

required

City name

Required string length: 1 - 64

ship_from.country

string

required

Country name

Required string length: 1 - 128

ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

ship_from.province

string

required

State name

Required string length: 1 - 32

ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

ship_from.email

string | null

Contact email address

Maximum length: 128

ship_from.fax

string | null

Fax number

Maximum length: 32

ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

ship_from.id

integer

Address ID

ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

ship_from.phone1

string | null

Primary contact number

Maximum length: 32

ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

ship_to

object

Show child attributes

ship_to.city

string

required

City name

Required string length: 1 - 64

ship_to.country

string

required

Country name

Required string length: 1 - 128

ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

ship_to.province

string

required

State name

Required string length: 1 - 32

ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

ship_to.email

string | null

Contact email address

Maximum length: 128

ship_to.fax

string | null

Fax number

Maximum length: 32

ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

ship_to.id

integer

Address ID

ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

ship_to.phone1

string | null

Primary contact number

Maximum length: 32

ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

shipment_count

integer

Shipment count

shipments

object[]

Show child attributes

shipments.order_id

integer

required

Order ID

shipments.acknowledged_at

string | null

Time of acknowledgement (UTC format)

shipments.batch_number

integer | null

Batch number of shipment

Required range: -2147483648 < x < 2147483647

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

shipments.brand.cover_url

string

URL of the cover image

Minimum length: 1

shipments.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

shipments.brand.id

integer

Vendor (brand) ID

shipments.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

shipments.brand.is_on_rcn

boolean

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

shipments.brand.is_onboarded

boolean

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

shipments.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

shipments.brand.logo_url

string

URL of the brand logo

Minimum length: 1

shipments.brand.name

string

Vendor name

Required string length: 1 - 64

shipments.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

shipments.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

shipments.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

shipments.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

shipments.brand.subscription_is_delinquent

boolean

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

shipments.brand.subscription_is_expired

boolean

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

shipments.brand.subscription_is_on_grace_period

boolean

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

shipments.brand.website

string | null

URL of brand website

Maximum length: 100

shipments.canceled_at

string | null

Time of cancellation (UTC format)

shipments.closed_at

string | null

Time of shipment closure (UTC format)

shipments.created_at

string

Time of shipment creation (UTC format)

shipments.customer_order_number

string

Customer order number

Minimum length: 1

shipments.delivered_at

string | null

Time of delivery (UTC format)

shipments.error_logs

object

Show child attributes

shipments.error_logs.count

integer

Count of error log

shipments.error_logs.created_at

string

Time of error log creation

shipments.error_logs.id

integer

Error log ID

shipments.error_logs.message

string | null

Message in error log

shipments.has_commercial_invoice

boolean

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

shipments.id

integer

Shipment ID

shipments.invoice_number

string

Invoice number

shipments.is_acknowledged

boolean

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

shipments.label_reference

string | null

Label reference

Maximum length: 30

shipments.ordered_at

string

Time of shipment creation (UTC format)

shipments.purchase_order_number

string

Purchase order number

Minimum length: 1

shipments.retailer_order_number

string

Retailer order number

Minimum length: 1

shipments.ship_from

object

Show child attributes

shipments.ship_from.city

string

required

City name

Required string length: 1 - 64

shipments.ship_from.country

string

required

Country name

Required string length: 1 - 128

shipments.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

shipments.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

shipments.ship_from.province

string

required

State name

Required string length: 1 - 32

shipments.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

shipments.ship_from.email

string | null

Contact email address

Maximum length: 128

shipments.ship_from.fax

string | null

Fax number

Maximum length: 32

shipments.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

shipments.ship_from.id

integer

Address ID

shipments.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

shipments.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

shipments.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

shipments.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

shipments.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

shipments.ship_girth

string

Shipment girth

shipments.ship_height

number | null

Shipment height

shipments.ship_length

number | null

Shipment length

shipments.ship_to

object

Show child attributes

shipments.ship_to.city

string

required

City name

Required string length: 1 - 64

shipments.ship_to.country

string

required

Country name

Required string length: 1 - 128

shipments.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

shipments.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

shipments.ship_to.province

string

required

State name

Required string length: 1 - 32

shipments.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

shipments.ship_to.email

string | null

Contact email address

Maximum length: 128

shipments.ship_to.fax

string | null

Fax number

Maximum length: 32

shipments.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

shipments.ship_to.id

integer

Address ID

shipments.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

shipments.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

shipments.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

shipments.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

shipments.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

shipments.ship_volume

string

Shipment volume

shipments.ship_weight

number | null

Shipment weight

shipments.ship_width

number | null

Shipment width

shipments.shipment_lines

object[]

Show child attributes

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

shipments.shipment_lines.id

integer

Shipment line ID

shipments.shipment_lines.order_line_number

string

Order line number

shipments.shipment_lines.part

integer

Internal only

Required range: -2147483648 < x < 2147483647

shipments.shipment_lines.quantity

integer

Order quantity

Required range: -2147483648 < x < 2147483647

shipments.shipment_lines.updated_at

string

Time of last update

shipments.shipment_lines.variant

object

Show child attributes

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

shipments.shipment_lines.variant.brand.id

integer

Vendor ID

shipments.shipment_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

shipments.shipment_lines.variant.brand_identifier

string

Brand identifier

Minimum length: 1

shipments.shipment_lines.variant.id

integer

Variant ID

shipments.shipment_lines.variant.identifier

string | null

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

Maximum length: 128

shipments.shipment_lines.variant.name

string | null

Variant name

Maximum length: 200

shipments.shipment_lines.variant.retailer_identifiers

object[]

Show child attributes

shipments.shipment_lines.variant.retailer_identifiers.id

integer

Retailer ID

shipments.shipment_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

shipments.shipment_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

shipments.shipment_lines.variant.retailer_identifiers.retailer

object

Show child attributes

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

shipments.shipped_at

string | null

Time of shipping (UTC format)

shipments.shipping_account

object

Show child attributes

shipments.shipping_account.nickname

string

required

Nickname of shipping account

Required string length: 1 - 64

shipments.shipping_account.carrier

object

Show child attributes

shipments.shipping_account.carrier.code

string

Carrier code

Required string length: 1 - 64

shipments.shipping_account.carrier.id

integer

Carrier ID

shipments.shipping_account.carrier.name

string

Carrier name

Required string length: 1 - 64

shipments.shipping_account.id

integer

Shipping account ID

shipments.shipping_account.is_first_party_bill

boolean

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

shipments.shipping_account.owner

string

Owner of shipping account

shipments.shipping_method

object

Show child attributes

shipments.shipping_method.code

string

required

Code of shipping method

Required string length: 1 - 64

shipments.shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 64

shipments.shipping_method.carrier

object

Show child attributes

shipments.shipping_method.carrier.code

string

Carrier code

Required string length: 1 - 64

shipments.shipping_method.carrier.id

integer

Carrier ID

shipments.shipping_method.carrier.name

string

Carrier name

Required string length: 1 - 64

shipments.shipping_method.generic_shipping_method

object

Show child attributes

shipments.shipping_method.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

shipments.shipping_method.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

shipments.shipping_method.generic_shipping_method.id

integer

ID of shipping method

shipments.shipping_method.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

shipments.shipping_method.id

integer

ID of shipping method

shipments.shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

shipments.shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum length: 64

shipments.signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

shipments.sold_to

object

Show child attributes

shipments.sold_to.city

string

required

City name

Required string length: 1 - 64

shipments.sold_to.country

string

required

Country name

Required string length: 1 - 128

shipments.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

shipments.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

shipments.sold_to.province

string

required

State name

Required string length: 1 - 32

shipments.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

shipments.sold_to.email

string | null

Contact email address

Maximum length: 128

shipments.sold_to.fax

string | null

Fax number

Maximum length: 32

shipments.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

shipments.sold_to.id

integer

Address ID

shipments.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

shipments.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

shipments.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

shipments.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

shipments.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

shipments.status

string

Status of shipment

Minimum length: 1

shipments.tracking

object

Show child attributes

shipments.tracking.delivered_at

string | null

Time of order delivery

shipments.tracking.picked_up_at

string | null

Time of order pickup

shipments.tracking.tracking_details

object[]

Show child attributes

shipments.tracking.tracking_details.status

string

required

Tracking status

Required string length: 1 - 32

shipments.tracking.tracking_details.status_detail

string

required

Status details

Required string length: 1 - 64

shipments.tracking.tracking_details.Time

string

required

Time of tracking (UTC format)

shipments.tracking.tracking_details.city

string | null

City of delivery

Maximum length: 32

shipments.tracking.tracking_details.country

string | null

Country of delivery

Maximum length: 8

shipments.tracking.tracking_details.id

integer

Tracking ID

shipments.tracking.tracking_details.postal_code

string | null

Postal code for delivery

Maximum length: 16

shipments.tracking.tracking_details.state

string | null

State of delivery

Maximum length: 8

shipments.tracking_number

string | null

Tracking number for shipment

Maximum length: 128

shipments.tracking_url

string

URL for tracking shipment

shipments.updated_at

string

Time of shipment update (UTC format)

shipments.valid_packing_slip

boolean

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

shipments.valid_shipping_label

boolean

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

shipping_charged

string

Shipped charged

shipping_method

object

Show child attributes

shipping_method.code

string

required

Code of shipping method

Required string length: 1 - 64

shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 64

shipping_method.carrier

object

Show child attributes

shipping_method.carrier.code

string

Carrier code

Required string length: 1 - 64

shipping_method.carrier.id

integer

Carrier ID

shipping_method.carrier.name

string

Carrier name

Required string length: 1 - 64

shipping_method.generic_shipping_method

object

Show child attributes

shipping_method.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

shipping_method.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

shipping_method.generic_shipping_method.id

integer

ID of shipping method

shipping_method.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

shipping_method.id

integer

ID of shipping method

shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

signature

enum<string> | null

Represents whether signature is required

Available options:

required,

not_required,

adult

sold_to

object

Show child attributes

sold_to.city

string

required

City name

Required string length: 1 - 64

sold_to.country

string

required

Country name

Required string length: 1 - 128

sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

sold_to.province

string

required

State name

Required string length: 1 - 32

sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

sold_to.email

string | null

Contact email address

Maximum length: 128

sold_to.fax

string | null

Fax number

Maximum length: 32

sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

sold_to.id

integer

Address ID

sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

sold_to.phone1

string | null

Primary contact number

Maximum length: 32

sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

status

string

Order status

Minimum length: 1

subtotal_charged

string

Subtotal amount excluding shipping

tags

object[]

Show child attributes

tags.created_at

string

Time of object tag creation (UTC format)

tags.created_by

object

Show child attributes

tags.created_by.first_name

string | null

First name of user

Maximum length: 64

tags.created_by.id

integer

User ID who accepted or rejected the invoice

tags.created_by.is_me

boolean

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

tags.created_by.last_name

string | null

Last name of user

Maximum length: 64

tags.created_by.photo_url

string

URL of the user photo

Minimum length: 1

tags.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

tags.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

tags.created_by.title

string | null

User title

Maximum length: 64

tags.created_by.type

enum<string>

User type

Available options:

standard,

api

tags.id

integer

Object tag ID

tags.tag

string

Object tag

tags.updated_at

string

Time of last update (UTC format)

unread_memos_count

integer

Number of unread memos

updated_at

string

Time of order update (UTC format)