Get orders

Gets a list of orders.

Authorizations

Authorization

string

header

required

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

Path Parameters

retailer_pk

string

required

Retailer ID

Query Parameters

retailer_order_num

string

Retailer order number

tags

string[]

Tags used for categorization. Multiple values may be added, separated by commas.

metadata

string[]

Meta data. Multiple values may be added, separated by commas.

metadata_value

string

Metadata values

generic_shipping_method

string[]

Shipping methods (names). Multiple values may be added, separated by comma

purchase_order_number

string

Purchase order number

customer_order_number

string

Customer order number

retailer_order_number

string

Retailer order number

search_order_number

string

Search by purchase order number, customer order number or retailer order number

variant_id

number[]

Variant IDs. Multiple values may be separated by commas.

variant_identifier

string[]

Variant SKUs. Multiple values may be added, separated by commas.

retailer_category

string[]

Retailer categories. Multiple values may be separated by commas.

retailer_category_id

number[]

Retailer category IDs. Multiple values may be separated by commas.

workflow

string[]

Status of the order such as pending, new, creating_shipments, ship, invoice, creating_invoices, on_hold, closed, shipping_errors, and invoice_errors. Multiple values may be separated by commas.

status

string

Order status such as open, closed partial, *pending and cancelled.

shipment_status

string

Shipment status such as open, closed, partial, *pending, and cancelled

orderline_status

string

Order line status

is_gift

number

1: Order is a gift <br /> 0: Order is not a gift

is_replacement

number

1: Order is a replacement <br /> 0: Order is not a replacement

is_backordered

number

1: Product is backordered <br /> 0: Product is not backordered

shipment_is_acknowledged

number

1: Shipment is acknowledged <br /> 0: Shipment is not acknowledged

cancel_is_acknowledged

number

1: Cancellation is acknowledged <br /> 0: Cancellation is not acknowledged

invoice_is_acknowledged

number

1: Invoice is acknowledged <br /> 0: Invoice is not acknowledged

rma_is_acknowledged

number

1: RMA is acknowledged <br /> 0: RMA is not acknowledged

backorder_is_acknowledged

number

1: Backorder is acknowledged <br /> 0: Backorder is not acknowledged

has_shipments

number

1: Order has shipments <br /> 0: Order does not have shipments

has_cancels

number

1: Order has cancellation <br /> 0: Order does not have cancellation

has_invoices

number

1: Order has invoices <br /> 0: Order does not have invoices

has_rmas

number

1: Order has RMA <br /> 0: Order does not have RMA

not_fully_shipped

number

1: Order is not fully shipped <br /> 0: Order is fully shipped

not_fully_invoiced

number

1: Order is not fully invoiced <br /> 0: Order is fully invoiced

cancel_acknowledged_at_gt

number

Cancellation acknowledgement date is greater than specified Time (Unix epoch format)

cancel_acknowledged_at_gte

number

Cancellation acknowledgement date is greater than or equal to specified Time (Unix epoch format)

cancel_acknowledged_at_lt

number

Cancellation acknowledgement date is less than specified Time (Unix epoch format)

cancel_acknowledged_at_lte

number

Cancellation acknowledgement date is less than or equal to specified Time (Unix epoch format)

backordered_until_gt

number

Backordered date is greater than specified Time (Unix epoch format)

backordered_until_gte

number

Backordered date is greater than or equal to specified Time (Unix epoch format)

backordered_until_lt

number

Backordered date is less than specified Time (Unix epoch format)

backordered_until_lte

number

Backordered date is less than or equal to specified Time (Unix epoch format)

memos_created_at_gte

number

Memos creation date is greater than or equal to specified Time (Unix epoch format)

since

number

Past date till the current time (Unix epoch format)

order_batch_id

number[]

Batch ID of order. Multiple values may be separated by commas.

brand_id

number[]

Vendor IDs. Multiple values may be separated by commas.

retailer_id

number[]

Retailer ID. Multiple values may be separated by commas.

connection_id

number[]

Connection ID. Multiple values may be separated by commas.Connection ID

order_by

string

Sorting preference

page

integer

Page number of the paginated response

limit

integer

Number of results per page

Response

200 - application/json

count

integer

required

Total number of records

results

object[]

required

Show child attributes

results.ordered_at

string

required

Time of order finalization (UTC format)

results.purchase_order_number

string

required

Purchase order number

Minimum length: 1

results.acknowledged_at

string | null

Time of order acknowledgement (UTC format)

results.allow_shipping_label_generation

boolean

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

results.attachments

object[]

Show child attributes

results.attachments.content_type

integer

Content type

results.attachments.file

string | null

File name

results.attachments.filename

string | null

File name used for sharing

Maximum length: 255

results.attachments.id

integer

Attachment or document ID

results.attachments.object_id

integer

Attachement object ID

results.attachments.original_filename

string | null

Original file name

Maximum length: 255

results.attachments.tags

object[]

Show child attributes

results.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

results.attachments.tags.id

integer

Attachment tag ID

results.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

results.attachments.url

string

URL of attachment

Minimum length: 1

results.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

results.backorder_acknowledged_at

string | null

Time of backorder acknowledgement (UTC format)

results.backordered_until

string | null

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

results.bill_to

object

Show child attributes

results.bill_to.city

string

required

City name

Required string length: 1 - 64

results.bill_to.country

string

required

Country name

Required string length: 1 - 128

results.bill_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.bill_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.bill_to.province

string

required

State name

Required string length: 1 - 32

results.bill_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.bill_to.email

string | null

Contact email address

Maximum length: 128

results.bill_to.fax

string | null

Fax number

Maximum length: 32

results.bill_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.bill_to.id

integer

Address ID

results.bill_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.bill_to.phone1

string | null

Primary contact number

Maximum length: 32

results.bill_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.bill_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.bill_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.brand

object

Show child attributes

results.brand.code

string

required

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

Required string length: 1 - 64

results.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.brand.id

integer

Vendor (brand) ID

results.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.brand.is_on_rcn

boolean

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

results.brand.is_onboarded

boolean

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

results.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.brand.name

string

Vendor name

Required string length: 1 - 64

results.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.brand.subscription_is_delinquent

boolean

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

results.brand.subscription_is_expired

boolean

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

results.brand.subscription_is_on_grace_period

boolean

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

results.brand.website

string | null

URL of brand website

Maximum length: 100

results.brand_identifier

string | null

Vendor identifier

Maximum length: 64

results.brands

object[]

Show child attributes

results.brands.code

string

required

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

Required string length: 1 - 64

results.brands.cover_url

string

URL of the cover image

Minimum length: 1

results.brands.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.brands.id

integer

Vendor (brand) ID

results.brands.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.brands.is_on_rcn

boolean

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

results.brands.is_onboarded

boolean

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

results.brands.joined_at

string

Time when vendor joined Dropship (UTC format)

results.brands.logo_url

string

URL of the brand logo

Minimum length: 1

results.brands.name

string

Vendor name

Required string length: 1 - 64

results.brands.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.brands.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.brands.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.brands.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.brands.subscription_is_delinquent

boolean

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

results.brands.subscription_is_expired

boolean

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

results.brands.subscription_is_on_grace_period

boolean

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

results.brands.website

string | null

URL of brand website

Maximum length: 100

results.canceled_at

string | null

Time of order cancellation (UTC format)

results.cancels

object[]

Show child attributes

results.cancels.reason_id

integer

required

Reason ID associated with cancellation

results.cancels.acknowledged_at

string | null

Time of cancellation acknowledgement (UTC format)

results.cancels.brand

object

Show child attributes

results.cancels.brand.code

string

required

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

Required string length: 1 - 64

results.cancels.brand.id

integer

Vendor ID

results.cancels.brand.name

string

Vendor name

Required string length: 1 - 64

results.cancels.cancel_lines

object[]

Show child attributes

results.cancels.cancel_lines.estimated_availability_date

string | null

Estimated availability date of variant

results.cancels.cancel_lines.id

integer

Cancel line ID

results.cancels.cancel_lines.quantity

integer

Variant quantity

Required range: -2147483648 < x < 2147483647

results.cancels.cancel_lines.variant

string

Variant name

results.cancels.canceled_at

string | null

Time of cancellation (UTC format)

results.cancels.canceled_by

enum<string> | null

User that initiated cancellation

Available options:

retailer,

brand

results.cancels.id

integer

Cancellation ID

results.cancels.order_id

integer

Order ID

results.cancels.purchase_order_number

string

Purchase order number

Minimum length: 1

results.cancels.reason

string

Cancellation reason

Minimum length: 1

results.cancels.retailer

object

Show child attributes

results.cancels.retailer.code

string

required

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

Required string length: 1 - 32

results.cancels.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.cancels.retailer.id

integer

Retailer ID

results.closed_at

string

Time of complete order fulfillment (UTC format)

results.connection_id

integer

A numeric connection ID

results.connection_shipping_provider_account

object

Show child attributes

results.connection_shipping_provider_account.connection

object

Show child attributes

results.connection_shipping_provider_account.connection.brand

object

Show child attributes

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

results.connection_shipping_provider_account.connection.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.connection_shipping_provider_account.connection.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.connection_shipping_provider_account.connection.brand.id

integer

Vendor (brand) ID

results.connection_shipping_provider_account.connection.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.connection_shipping_provider_account.connection.brand.is_on_rcn

boolean

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

results.connection_shipping_provider_account.connection.brand.is_onboarded

boolean

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

results.connection_shipping_provider_account.connection.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.connection_shipping_provider_account.connection.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.connection_shipping_provider_account.connection.brand.name

string

Vendor name

Required string length: 1 - 64

results.connection_shipping_provider_account.connection.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.connection_shipping_provider_account.connection.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.connection_shipping_provider_account.connection.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.connection_shipping_provider_account.connection.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.connection_shipping_provider_account.connection.brand.subscription_is_delinquent

boolean

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

results.connection_shipping_provider_account.connection.brand.subscription_is_expired

boolean

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

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

results.connection_shipping_provider_account.connection.brand.website

string | null

URL of brand website

Maximum length: 100

results.connection_shipping_provider_account.connection.connection_adjustments

object[]

Show child attributes

results.connection_shipping_provider_account.connection.connection_adjustments.description

string

required

Description of adjustment

Required string length: 1 - 256

results.connection_shipping_provider_account.connection.connection_adjustments.adjustment_amount

string

Adjustment amount

results.connection_shipping_provider_account.connection.connection_adjustments.adjustment_amount_type

enum<string>

Adjustment type - dollar amount or percentage

Available options:

percent,

flat

results.connection_shipping_provider_account.connection.connection_adjustments.adjustment_code

object

Show child attributes

results.connection_shipping_provider_account.connection.connection_adjustments.adjustment_type

string

Adjustment type

results.connection_shipping_provider_account.connection.connection_adjustments.content_type

string

Content type

Minimum length: 1

results.connection_shipping_provider_account.connection.connection_adjustments.id

integer

Connection adjustment ID, used for monetary adjustments

results.connection_shipping_provider_account.connection.connection_adjustments.object_id

integer | null

Object ID

Required range: 0 < x < 4294967295

results.connection_shipping_provider_account.connection.created_at

string

Time of connection creation

results.connection_shipping_provider_account.connection.id

integer

Connection ID

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

results.connection_shipping_provider_account.connection.level

enum<string>

Connection type

Available options:

basic,

full

results.connection_shipping_provider_account.connection.metadata

string

Metadata

results.connection_shipping_provider_account.connection.options

object

Show child attributes

results.connection_shipping_provider_account.connection.options.code

string

required

Option code

Required string length: 1 - 64

results.connection_shipping_provider_account.connection.options.name

string

required

Option name

Required string length: 1 - 64

results.connection_shipping_provider_account.connection.options.description

string | null

Connection description

results.connection_shipping_provider_account.connection.options.editable_by

enum<string> | null

User who can edit connection

Available options:

retailer,

brand,

staff

results.connection_shipping_provider_account.connection.options.id

integer

Option ID

results.connection_shipping_provider_account.connection.options.viewable_by

enum<string> | null

User who can view the connection details

Available options:

retailer,

brand,

all,

none

results.connection_shipping_provider_account.connection.retailer

object

Show child attributes

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

results.connection_shipping_provider_account.connection.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

results.connection_shipping_provider_account.connection.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.connection_shipping_provider_account.connection.retailer.id

integer

Retailer ID

results.connection_shipping_provider_account.connection.retailer.is_onboarded

boolean

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

results.connection_shipping_provider_account.connection.retailer.is_rcn_retailer

boolean

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

results.connection_shipping_provider_account.connection.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.connection_shipping_provider_account.connection.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.connection_shipping_provider_account.connection.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.connection_shipping_provider_account.connection.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.connection_shipping_provider_account.connection.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.connection_shipping_provider_account.connection.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.connection_shipping_provider_account.connection.retailer.website

string | null

Website URL

Maximum length: 100

results.connection_shipping_provider_account.connection.retailer_identifier

string | null

Variant identifier specific to retailer

Maximum length: 32

results.connection_shipping_provider_account.connection.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

results.connection_shipping_provider_account.created_at

string

Time of creation (UTC format)

results.connection_shipping_provider_account.id

integer

Shipping carrier account ID

results.connection_shipping_provider_account.shipping_methods

object

Show child attributes

results.connection_shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

results.connection_shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

results.connection_shipping_provider_account.shipping_methods.carrier

object

Show child attributes

results.connection_shipping_provider_account.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

results.connection_shipping_provider_account.shipping_methods.carrier.id

integer

Carrier ID

results.connection_shipping_provider_account.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

results.connection_shipping_provider_account.shipping_methods.generic_shipping_method

object

Show child attributes

results.connection_shipping_provider_account.shipping_methods.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

results.connection_shipping_provider_account.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

results.connection_shipping_provider_account.shipping_methods.generic_shipping_method.id

integer

ID of shipping method

results.connection_shipping_provider_account.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.connection_shipping_provider_account.shipping_methods.id

integer

ID of shipping method

results.connection_shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.connection_shipping_provider_account.shipping_provider_account

object

Show child attributes

results.connection_shipping_provider_account.shipping_provider_account.created_at

string

Time of account (UTC format)

results.connection_shipping_provider_account.shipping_provider_account.credential_values

object[]

Show child attributes

results.connection_shipping_provider_account.shipping_provider_account.credential_values.created_at

string

Time of credentials creation (UTC format)

results.connection_shipping_provider_account.shipping_provider_account.credential_values.credential

object

Show child attributes

results.connection_shipping_provider_account.shipping_provider_account.credential_values.id

integer

Credentials ID

results.connection_shipping_provider_account.shipping_provider_account.credential_values.updated_at

string

Time of credentials update (UTC format)

results.connection_shipping_provider_account.shipping_provider_account.credential_values.value

string

Credentials value

results.connection_shipping_provider_account.shipping_provider_account.id

integer

Account ID of shipping provider

results.connection_shipping_provider_account.shipping_provider_account.shipping_methods

object

Show child attributes

results.connection_shipping_provider_account.shipping_provider_account.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

results.connection_shipping_provider_account.shipping_provider_account.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

results.connection_shipping_provider_account.shipping_provider_account.shipping_methods.carrier

object

Show child attributes

results.connection_shipping_provider_account.shipping_provider_account.shipping_methods.generic_shipping_method

object

Show child attributes

results.connection_shipping_provider_account.shipping_provider_account.shipping_methods.id

integer

ID of shipping method

results.connection_shipping_provider_account.shipping_provider_account.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.connection_shipping_provider_account.shipping_provider_account.shipping_provider

object

Show child attributes

results.connection_shipping_provider_account.shipping_provider_account.shipping_provider.created_at

string

Time of shipping provider creation (UTC format)

results.connection_shipping_provider_account.shipping_provider_account.shipping_provider.credentials

string

Credentials for shipping provider

results.connection_shipping_provider_account.shipping_provider_account.shipping_provider.id

integer

Shipping provider ID

results.connection_shipping_provider_account.shipping_provider_account.shipping_provider.name

string | null

Name of shipping provider

Maximum length: 32

results.connection_shipping_provider_account.shipping_provider_account.shipping_provider.shipping_methods

string

Shipping methods

results.connection_shipping_provider_account.shipping_provider_account.shipping_provider.updated_at

string

Time of shipping provider update (UTC format)

results.connection_shipping_provider_account.shipping_provider_account.updated_at

string

Time of account update (UTC format)

results.connection_shipping_provider_account.updated_at

string

Time of last update (UTC format)

results.credits

object[]

Show child attributes

results.credits.acknowledged_at

string | null

Time of credit acknowledgement

results.credits.adjustments

object[]

Show child attributes

results.credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

results.credits.adjustments.id

integer

Adjustment ID

results.credits.adjustments.net_price

string

Adjustment net price

results.credits.brand

object

Show child attributes

results.credits.brand.code

string

required

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

Required string length: 1 - 64

results.credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.credits.brand.id

integer

Vendor (brand) ID

results.credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.credits.brand.is_on_rcn

boolean

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

results.credits.brand.is_onboarded

boolean

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

results.credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.credits.brand.name

string

Vendor name

Required string length: 1 - 64

results.credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.credits.brand.subscription_is_delinquent

boolean

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

results.credits.brand.subscription_is_expired

boolean

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

results.credits.brand.subscription_is_on_grace_period

boolean

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

results.credits.brand.website

string | null

URL of brand website

Maximum length: 100

results.credits.created_at

string

Time of creation (UTC format)

results.credits.credit_amount

string

Credit amount

results.credits.credit_lines

object[]

Show child attributes

results.credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 < x < 2147483647

results.credits.credit_lines.id

integer

Credit line ID

results.credits.credit_lines.net_price

string

Credit line net price

results.credits.credit_lines.variant

object

Show child attributes

results.credits.credit_lines.variant.active_permit

object

Show child attributes

results.credits.credit_lines.variant.attributes

object[]

Show child attributes

results.credits.credit_lines.variant.brand

object

Show child attributes

results.credits.credit_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

results.credits.credit_lines.variant.cartons

object[]

Show child attributes

results.credits.credit_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

results.credits.credit_lines.variant.id

integer

Variant ID

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

results.credits.credit_lines.variant.inventory

object

Show child attributes

results.credits.credit_lines.variant.is_compatible

boolean

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

results.credits.credit_lines.variant.media

object[]

Show child attributes

results.credits.credit_lines.variant.name

string | null

Variant Name

Maximum length: 200

results.credits.credit_lines.variant.permits

object[]

Show child attributes

results.credits.credit_lines.variant.proposal_variant

object

Show child attributes

results.credits.credit_lines.variant.retailer_categories

object

Show child attributes

results.credits.credit_lines.variant.retailer_identifiers

object

Show child attributes

results.credits.credit_lines.variant.ruleset_variant_summary

string

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

results.credits.credit_lines.variant.ruleset_variants

object[]

Show child attributes

results.credits.credit_lines.variant.size

string | null

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

Maximum length: 128

results.credits.credit_lines.variant.style

string | null

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

Maximum length: 128

results.credits.credit_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

results.credits.credit_number

string | null

Credit number

Maximum length: 32

results.credits.credited_at

string | null

Time of credit (UTC format)

results.credits.currency

object

Show child attributes

results.credits.currency.id

integer

Currency ID

results.credits.currency.name

string

Currency name

Maximum length: 200

results.credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

results.credits.currency.unit

string

Currency unit

results.credits.id

integer

Credit ID

results.credits.invoice

object

Show child attributes

results.credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

results.credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

results.credits.invoice.allowances

object[]

Show child attributes

results.credits.invoice.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

results.credits.invoice.allowances.price

string

required

Allowance price

results.credits.invoice.allowances.adjustment_code

object

Show child attributes

results.credits.invoice.allowances.id

integer

Allowance ID

results.credits.invoice.brand

object

Show child attributes

results.credits.invoice.brand.code

string

required

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

Required string length: 1 - 64

results.credits.invoice.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.credits.invoice.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.credits.invoice.brand.id

integer

Vendor (brand) ID

results.credits.invoice.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.credits.invoice.brand.is_on_rcn

boolean

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

results.credits.invoice.brand.is_onboarded

boolean

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

results.credits.invoice.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.credits.invoice.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.credits.invoice.brand.name

string

Vendor name

Required string length: 1 - 64

results.credits.invoice.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.credits.invoice.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.credits.invoice.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.credits.invoice.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.credits.invoice.brand.subscription_is_delinquent

boolean

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

results.credits.invoice.brand.subscription_is_expired

boolean

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

results.credits.invoice.brand.subscription_is_on_grace_period

boolean

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

results.credits.invoice.brand.website

string | null

URL of brand website

Maximum length: 100

results.credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

results.credits.invoice.charges

object[]

Show child attributes

results.credits.invoice.charges.description

string

required

Invoice description

Required string length: 1 - 128

results.credits.invoice.charges.price

string

required

Invoice price

results.credits.invoice.charges.adjustment_code

object

Show child attributes

results.credits.invoice.charges.id

integer

Invoice ID

results.credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

results.credits.invoice.connection_id

string

Connection ID

results.credits.invoice.currency

object

Show child attributes

results.credits.invoice.currency.id

integer

Currency ID

results.credits.invoice.currency.name

string

Currency name

Maximum length: 200

results.credits.invoice.currency.symbol

string | null

Currency symbol

Maximum length: 5

results.credits.invoice.currency.unit

string

Currency unit

results.credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

results.credits.invoice.due_amount

string | null

Pending amount

results.credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

results.credits.invoice.id

integer

Invoice ID

results.credits.invoice.invoice_acceptance

object

Show child attributes

results.credits.invoice.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

results.credits.invoice.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

results.credits.invoice.invoice_acceptance.id

integer

Invoice acceptance ID

results.credits.invoice.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

results.credits.invoice.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

results.credits.invoice.invoice_acceptance.rejected_by

object

Show child attributes

results.credits.invoice.invoice_lines

object[]

Show child attributes

results.credits.invoice.invoice_lines.price

string

required

Discounted price

results.credits.invoice.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 < x < 2147483647

results.credits.invoice.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

results.credits.invoice.invoice_lines.description

string | null

Product description

Maximum length: 128

results.credits.invoice.invoice_lines.id

integer

Invoice line ID

results.credits.invoice.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 < x < 2147483647

results.credits.invoice.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

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

results.credits.invoice.invoice_lines.name

string | null

Product name

Maximum length: 128

results.credits.invoice.invoice_lines.retail_price

string

Retail price

results.credits.invoice.invoice_lines.variant

object

Show child attributes

results.credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

results.credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

results.credits.invoice.notes

string | null

Addition info adding to shipping

results.credits.invoice.order_id

integer

Order ID related to invoice

results.credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

results.credits.invoice.paid_at

string | null

Time of payment (UTC format)

results.credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

results.credits.invoice.remit_to

object

Show child attributes

results.credits.invoice.remit_to.city

string

required

City name

Required string length: 1 - 64

results.credits.invoice.remit_to.country

string

required

Country name

Required string length: 1 - 128

results.credits.invoice.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.credits.invoice.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.credits.invoice.remit_to.province

string

required

State name

Required string length: 1 - 32

results.credits.invoice.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.credits.invoice.remit_to.email

string | null

Contact email address

Maximum length: 128

results.credits.invoice.remit_to.fax

string | null

Fax number

Maximum length: 32

results.credits.invoice.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.credits.invoice.remit_to.id

integer

Address ID

results.credits.invoice.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.credits.invoice.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

results.credits.invoice.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.credits.invoice.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.credits.invoice.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.credits.invoice.retailer

object

Show child attributes

results.credits.invoice.retailer.code

string

required

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

Required string length: 1 - 32

results.credits.invoice.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

results.credits.invoice.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.credits.invoice.retailer.id

integer

Retailer ID

results.credits.invoice.retailer.is_onboarded

boolean

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

results.credits.invoice.retailer.is_rcn_retailer

boolean

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

results.credits.invoice.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.credits.invoice.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.credits.invoice.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.credits.invoice.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.credits.invoice.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.credits.invoice.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.credits.invoice.retailer.website

string | null

Website URL

Maximum length: 100

results.credits.invoice.ship_from

object

Show child attributes

results.credits.invoice.ship_from.city

string

required

City name

Required string length: 1 - 64

results.credits.invoice.ship_from.country

string

required

Country name

Required string length: 1 - 128

results.credits.invoice.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.credits.invoice.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

results.credits.invoice.ship_from.province

string

required

State name

Required string length: 1 - 32

results.credits.invoice.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.credits.invoice.ship_from.email

string | null

Contact email address

Maximum length: 128

results.credits.invoice.ship_from.fax

string | null

Fax number

Maximum length: 32

results.credits.invoice.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.credits.invoice.ship_from.id

integer

Address ID

results.credits.invoice.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.credits.invoice.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

results.credits.invoice.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

results.credits.invoice.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

results.credits.invoice.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.credits.invoice.ship_to

object

Show child attributes

results.credits.invoice.ship_to.city

string

required

City name

Required string length: 1 - 64

results.credits.invoice.ship_to.country

string

required

Country name

Required string length: 1 - 128

results.credits.invoice.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.credits.invoice.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.credits.invoice.ship_to.province

string

required

State name

Required string length: 1 - 32

results.credits.invoice.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.credits.invoice.ship_to.email

string | null

Contact email address

Maximum length: 128

results.credits.invoice.ship_to.fax

string | null

Fax number

Maximum length: 32

results.credits.invoice.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.credits.invoice.ship_to.id

integer

Address ID

results.credits.invoice.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.credits.invoice.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

results.credits.invoice.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.credits.invoice.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.credits.invoice.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

results.credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

results.credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

results.credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

results.credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

results.credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

results.credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

results.credits.invoice.shipping_weight

string | null

Shipping weight

results.credits.invoice.sold_to

object

Show child attributes

results.credits.invoice.sold_to.city

string

required

City name

Required string length: 1 - 64

results.credits.invoice.sold_to.country

string

required

Country name

Required string length: 1 - 128

results.credits.invoice.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.credits.invoice.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.credits.invoice.sold_to.province

string

required

State name

Required string length: 1 - 32

results.credits.invoice.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.credits.invoice.sold_to.email

string | null

Contact email address

Maximum length: 128

results.credits.invoice.sold_to.fax

string | null

Fax number

Maximum length: 32

results.credits.invoice.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.credits.invoice.sold_to.id

integer

Address ID

results.credits.invoice.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.credits.invoice.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

results.credits.invoice.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.credits.invoice.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.credits.invoice.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

results.credits.invoice.subtotal

string | null

Sub-total

results.credits.invoice.tax

string | null

Total tax on the invoice

results.credits.invoice.terms_date_due

string | null

Payment expected date

results.credits.invoice.terms_description

string | null

Description of invoice terms

results.credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

results.credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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

results.credits.order

string

Order details

results.credits.retailer

object

Show child attributes

results.credits.retailer.code

string

required

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

Required string length: 1 - 32

results.credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.credits.retailer.brand_permit_creation_allowed

boolean

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

results.credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.credits.retailer.id

integer

Retailer ID

results.credits.retailer.is_onboarded

boolean

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

results.credits.retailer.is_rcn_retailer

boolean

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

results.credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.credits.retailer.website

string | null

Website URL

Maximum length: 100

results.credits.rma

object

Show child attributes

results.credits.rma.order_id

integer

required

Order ID

results.credits.rma.reason_id

integer

required

ID associated with return reason

results.credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

results.credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

results.credits.rma.attachments

object[]

Show child attributes

results.credits.rma.attachments.content_type

integer

Content type

results.credits.rma.attachments.file

string | null

File name

results.credits.rma.attachments.filename

string | null

File name used for sharing

Maximum length: 255

results.credits.rma.attachments.id

integer

Attachment or document ID

results.credits.rma.attachments.object_id

integer

Attachement object ID

results.credits.rma.attachments.original_filename

string | null

Original file name

Maximum length: 255

results.credits.rma.attachments.tags

object[]

Show child attributes

results.credits.rma.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

results.credits.rma.attachments.url

string

URL of attachment

Minimum length: 1

results.credits.rma.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

results.credits.rma.brand

object

Show child attributes

results.credits.rma.brand.code

string

required

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

Required string length: 1 - 64

results.credits.rma.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.credits.rma.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.credits.rma.brand.id

integer

Vendor (brand) ID

results.credits.rma.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.credits.rma.brand.is_on_rcn

boolean

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

results.credits.rma.brand.is_onboarded

boolean

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

results.credits.rma.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.credits.rma.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.credits.rma.brand.name

string

Vendor name

Required string length: 1 - 64

results.credits.rma.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.credits.rma.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.credits.rma.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.credits.rma.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.credits.rma.brand.subscription_is_delinquent

boolean

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

results.credits.rma.brand.subscription_is_expired

boolean

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

results.credits.rma.brand.subscription_is_on_grace_period

boolean

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

results.credits.rma.brand.website

string | null

URL of brand website

Maximum length: 100

results.credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

results.credits.rma.credits

object[]

Show child attributes

results.credits.rma.credits.acknowledged_at

string | null

Time of credit acknowledgement

results.credits.rma.credits.adjustments

object[]

Show child attributes

results.credits.rma.credits.brand

object

Show child attributes

results.credits.rma.credits.created_at

string

Time of creation (UTC format)

results.credits.rma.credits.credit_amount

string

Credit amount

results.credits.rma.credits.credit_lines

object[]

Show child attributes

results.credits.rma.credits.credit_number

string | null

Credit number

Maximum length: 32

results.credits.rma.credits.credited_at

string | null

Time of credit (UTC format)

results.credits.rma.credits.currency

object

Show child attributes

results.credits.rma.credits.id

integer

Credit ID

results.credits.rma.credits.invoice

object

Show child attributes

results.credits.rma.credits.order

string

Order details

results.credits.rma.credits.retailer

object

Show child attributes

results.credits.rma.credits.rma

object

Show child attributes

results.credits.rma.credits.subtotal

string

Subtotal amount

results.credits.rma.currency

object

Show child attributes

results.credits.rma.currency.id

integer

Currency ID

results.credits.rma.currency.name

string

Currency name

Maximum length: 200

results.credits.rma.currency.symbol

string | null

Currency symbol

Maximum length: 5

results.credits.rma.currency.unit

string

Currency unit

results.credits.rma.id

integer

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

results.credits.rma.memos

object[]

Show child attributes

results.credits.rma.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

results.credits.rma.memos.created_at

string

Time of memo creation (UTC format)

results.credits.rma.memos.created_by

object

Show child attributes

results.credits.rma.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

results.credits.rma.memos.id

integer

Memo ID

results.credits.rma.memos.notify_people

boolean

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

results.credits.rma.memos.text

string

Memo text

results.credits.rma.memos.updated_at

string

Time of memo update (UTC format)

results.credits.rma.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

results.credits.rma.ordered_at

string

Time of order finalization (UTC format)

results.credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

results.credits.rma.reason

string

Reason for return

Minimum length: 1

results.credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

results.credits.rma.retailer

object

Show child attributes

results.credits.rma.retailer.code

string

required

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

Required string length: 1 - 32

results.credits.rma.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

results.credits.rma.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.credits.rma.retailer.id

integer

Retailer ID

results.credits.rma.retailer.is_onboarded

boolean

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

results.credits.rma.retailer.is_rcn_retailer

boolean

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

results.credits.rma.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.credits.rma.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.credits.rma.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.credits.rma.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.credits.rma.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.credits.rma.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.credits.rma.retailer.website

string | null

Website URL

Maximum length: 100

results.credits.rma.rma_lines

object[]

Show child attributes

results.credits.rma.rma_lines.id

integer

RMA line ID

results.credits.rma.rma_lines.net_price

string

Net price

results.credits.rma.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 < x < 2147483647

results.credits.rma.rma_lines.quantity_shipped

integer

Quantity shipped

results.credits.rma.rma_lines.variant

object

Show child attributes

results.credits.rma.rma_number

string | null

RMA number

Maximum length: 32

results.credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

results.credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

results.credits.rma.total_amount

string

Total amount

results.credits.subtotal

string

Subtotal amount

results.currency

object

Show child attributes

results.currency.id

integer

Currency ID

results.currency.name

string

Currency name

Maximum length: 200

results.currency.symbol

string | null

Currency symbol

Maximum length: 5

results.currency.unit

string

Currency unit

results.customer_order_number

string | null

Customer order number

Maximum length: 64

results.envelopes

object[]

Show child attributes

results.envelopes.data_interchange_control_number

integer

required

Data interchange control number

Required range: 0 < x < 4294967295

results.envelopes.direction

enum<string>

required

Direction of envelop

Available options:

incoming,

outgoing

results.envelopes.functional_identifier

enum<string>

required

Functional identifier

Available options:

PO,

IN,

SH,

IB,

FA,

PR,

PC

results.envelopes.interchange_control_number

integer

required

Interchange control number

Required range: 0 < x < 4294967295

results.envelopes.accepted_at

string | null

Time of envelope acceptance (UTC format)

results.envelopes.created_at

string

Time of envelope creation (UTC format)

results.envelopes.documents

object[]

Show child attributes

results.envelopes.documents.transaction_set

enum<string>

required

Transaction set

Available options:

810,

846,

850,

855,

856,

860,

997

results.envelopes.documents.transaction_set_control_number

integer

required

Transaction set control number related to EDI

Required range: 0 < x < 4294967295

results.envelopes.documents.accepted_at

string | null

Time of document acceptance (UTC format)

results.envelopes.documents.id

integer

Document ID

results.envelopes.documents.jobs

object[]

Show child attributes

results.envelopes.documents.jobs.content_type

integer

required

Content type

results.envelopes.documents.jobs.module_name

string

required

Module name

Required string length: 1 - 64

results.envelopes.documents.jobs.object_id

integer

required

Object ID

Required range: 0 < x < 4294967295

results.envelopes.documents.jobs.runtime_id

string

required

Runtime ID

Required string length: 1 - 64

results.envelopes.documents.jobs.connection

object

Show child attributes

results.envelopes.documents.jobs.created_at

string

Time of job creation (UTC format)

results.envelopes.documents.jobs.description

string

Bried description of job, for future reference

results.envelopes.documents.jobs.error_count

string

Error count

results.envelopes.documents.jobs.error_logs

object

Show child attributes

results.envelopes.documents.jobs.finish_time

string

Time of job ending (UTC format)

results.envelopes.documents.jobs.id

integer

Job ID

results.envelopes.documents.jobs.metadata

object[]

results.envelopes.documents.jobs.start_time

string

Time of job beginning (UTC format)

results.envelopes.documents.jobs.total_failure

string

Unsuccessful completion of job

results.envelopes.documents.jobs.total_success

string

Successful completion of job

results.envelopes.documents.rejected_at

string | null

Time of document rejection (UTC format)

results.envelopes.edi

string

Electronic data exchange (EDI)

results.envelopes.element_delimiter

string

Element delimiter

Required string length: 1 - 12

results.envelopes.entities

object[]

Show child attributes

results.envelopes.entities.content_type

integer

required

Content type

results.envelopes.entities.envelope

object

required

Show child attributes

results.envelopes.entities.envelope.data_interchange_control_number

integer

required

Data interchange control number

Required range: 0 < x < 4294967295

results.envelopes.entities.envelope.direction

enum<string>

required

Direction of envelop

Available options:

incoming,

outgoing

results.envelopes.entities.envelope.functional_identifier

enum<string>

required

Functional identifier

Available options:

PO,

IN,

SH,

IB,

FA,

PR,

PC

results.envelopes.entities.envelope.interchange_control_number

integer

required

Interchange control number

Required range: 0 < x < 4294967295

results.envelopes.entities.envelope.accepted_at

string | null

Time of envelope acceptance (UTC format)

results.envelopes.entities.envelope.created_at

string

Time of envelope creation (UTC format)

results.envelopes.entities.envelope.documents

object[]

Show child attributes

results.envelopes.entities.envelope.edi

string

Electronic data exchange (EDI)

results.envelopes.entities.envelope.element_delimiter

string

Element delimiter

Required string length: 1 - 12

results.envelopes.entities.envelope.entities

object[]

Show child attributes

results.envelopes.entities.envelope.id

integer

Envelop ID

results.envelopes.entities.envelope.receiver

object

Show child attributes

results.envelopes.entities.envelope.rejected_at

string | null

Time of envelope rejection (UTC format)

results.envelopes.entities.envelope.request_acknowledgment

boolean

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

results.envelopes.entities.envelope.segment_delimiter

string

Segment delimited

Required string length: 1 - 12

results.envelopes.entities.envelope.sender

object

Show child attributes

results.envelopes.entities.envelope.sub_element_delimiter

string

Sub element delimiter

Required string length: 1 - 12

results.envelopes.entities.envelope.transmitted_at

string | null

Time of envelope transmittance (UTC format)

results.envelopes.entities.object_id

integer

required

Object ID associated with the content type

Required range: 0 < x < 4294967295

results.envelopes.entities.id

integer

Envelop entity ID

results.envelopes.id

integer

Envelop ID

results.envelopes.receiver

object

Show child attributes

results.envelopes.receiver.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

results.envelopes.receiver.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

results.envelopes.receiver.brand

object

Show child attributes

results.envelopes.receiver.brand.code

string

required

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

Required string length: 1 - 64

results.envelopes.receiver.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.envelopes.receiver.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.envelopes.receiver.brand.id

integer

Vendor (brand) ID

results.envelopes.receiver.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.envelopes.receiver.brand.is_on_rcn

boolean

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

results.envelopes.receiver.brand.is_onboarded

boolean

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

results.envelopes.receiver.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.envelopes.receiver.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.envelopes.receiver.brand.name

string

Vendor name

Required string length: 1 - 64

results.envelopes.receiver.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.envelopes.receiver.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.envelopes.receiver.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.envelopes.receiver.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.envelopes.receiver.brand.subscription_is_delinquent

boolean

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

results.envelopes.receiver.brand.subscription_is_expired

boolean

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

results.envelopes.receiver.brand.subscription_is_on_grace_period

boolean

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

results.envelopes.receiver.brand.website

string | null

URL of brand website

Maximum length: 100

results.envelopes.receiver.id

integer

EDI account ID

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

results.envelopes.receiver.retailer

object

Show child attributes

results.envelopes.receiver.retailer.code

string

required

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

Required string length: 1 - 32

results.envelopes.receiver.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

results.envelopes.receiver.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.envelopes.receiver.retailer.id

integer

Retailer ID

results.envelopes.receiver.retailer.is_onboarded

boolean

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

results.envelopes.receiver.retailer.is_rcn_retailer

boolean

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

results.envelopes.receiver.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.envelopes.receiver.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.envelopes.receiver.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.envelopes.receiver.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.envelopes.receiver.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.envelopes.receiver.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.envelopes.receiver.retailer.website

string | null

Website URL

Maximum length: 100

results.envelopes.receiver.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

results.envelopes.rejected_at

string | null

Time of envelope rejection (UTC format)

results.envelopes.request_acknowledgment

boolean

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

results.envelopes.segment_delimiter

string

Segment delimited

Required string length: 1 - 12

results.envelopes.sender

object

Show child attributes

results.envelopes.sender.identifier

string

required

Unique identifier of EDI account

Required string length: 1 - 32

results.envelopes.sender.secondary_identifier

string | null

required

Secondary identifier of EDI account

Maximum length: 32

results.envelopes.sender.brand

object

Show child attributes

results.envelopes.sender.brand.code

string

required

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

Required string length: 1 - 64

results.envelopes.sender.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.envelopes.sender.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.envelopes.sender.brand.id

integer

Vendor (brand) ID

results.envelopes.sender.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.envelopes.sender.brand.is_on_rcn

boolean

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

results.envelopes.sender.brand.is_onboarded

boolean

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

results.envelopes.sender.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.envelopes.sender.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.envelopes.sender.brand.name

string

Vendor name

Required string length: 1 - 64

results.envelopes.sender.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.envelopes.sender.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.envelopes.sender.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.envelopes.sender.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.envelopes.sender.brand.subscription_is_delinquent

boolean

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

results.envelopes.sender.brand.subscription_is_expired

boolean

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

results.envelopes.sender.brand.subscription_is_on_grace_period

boolean

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

results.envelopes.sender.brand.website

string | null

URL of brand website

Maximum length: 100

results.envelopes.sender.id

integer

EDI account ID

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

results.envelopes.sender.retailer

object

Show child attributes

results.envelopes.sender.retailer.code

string

required

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

Required string length: 1 - 32

results.envelopes.sender.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

results.envelopes.sender.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.envelopes.sender.retailer.id

integer

Retailer ID

results.envelopes.sender.retailer.is_onboarded

boolean

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

results.envelopes.sender.retailer.is_rcn_retailer

boolean

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

results.envelopes.sender.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.envelopes.sender.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.envelopes.sender.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.envelopes.sender.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.envelopes.sender.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.envelopes.sender.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.envelopes.sender.retailer.website

string | null

Website URL

Maximum length: 100

results.envelopes.sender.status

enum<string>

EDI account status

Available options:

setup,

testing,

active,

disabled,

suspended

results.envelopes.sub_element_delimiter

string

Sub element delimiter

Required string length: 1 - 12

results.envelopes.transmitted_at

string | null

Time of envelope transmittance (UTC format)

results.fill_time

string | null

Fill time

results.fulfill_by

string

Time when order will be completely fulfilled (UTC format)

results.fulfilled_at

string | null

Time of order fulfillment (UTC format)

results.gift_fee

string | null

Gift fee (if applicable)

results.gift_message

string

Gift message

results.id

integer

Order ID

results.invoice_count

integer

Invoice count

results.invoices

object[]

Show child attributes

results.invoices.invoice_number

string

required

Invoice number

Required string length: 1 - 32

results.invoices.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

results.invoices.allowances

object[]

Show child attributes

results.invoices.allowances.description

string

required

Description of allowance

Required string length: 1 - 128

results.invoices.allowances.price

string

required

Allowance price

results.invoices.allowances.adjustment_code

object

Show child attributes

results.invoices.allowances.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

results.invoices.allowances.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

results.invoices.allowances.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

results.invoices.allowances.adjustment_code.id

integer

Adjustment ID

results.invoices.allowances.id

integer

Allowance ID

results.invoices.brand

object

Show child attributes

results.invoices.brand.code

string

required

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

Required string length: 1 - 64

results.invoices.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.invoices.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.invoices.brand.id

integer

Vendor (brand) ID

results.invoices.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.invoices.brand.is_on_rcn

boolean

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

results.invoices.brand.is_onboarded

boolean

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

results.invoices.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.invoices.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.invoices.brand.name

string

Vendor name

Required string length: 1 - 64

results.invoices.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.invoices.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.invoices.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.invoices.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.invoices.brand.subscription_is_delinquent

boolean

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

results.invoices.brand.subscription_is_expired

boolean

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

results.invoices.brand.subscription_is_on_grace_period

boolean

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

results.invoices.brand.website

string | null

URL of brand website

Maximum length: 100

results.invoices.canceled_at

string | null

Time of order cancellation (UTC format)

results.invoices.charges

object[]

Show child attributes

results.invoices.charges.description

string

required

Invoice description

Required string length: 1 - 128

results.invoices.charges.price

string

required

Invoice price

results.invoices.charges.adjustment_code

object

Show child attributes

results.invoices.charges.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

results.invoices.charges.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

results.invoices.charges.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

results.invoices.charges.adjustment_code.id

integer

Adjustment ID

results.invoices.charges.id

integer

Invoice ID

results.invoices.closed_at

string | null

Time of complete invoice payment (UTC format)

results.invoices.connection_id

string

Connection ID

results.invoices.currency

object

Show child attributes

results.invoices.currency.id

integer

Currency ID

results.invoices.currency.name

string

Currency name

Maximum length: 200

results.invoices.currency.symbol

string | null

Currency symbol

Maximum length: 5

results.invoices.currency.unit

string

Currency unit

results.invoices.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

results.invoices.due_amount

string | null

Pending amount

results.invoices.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

results.invoices.id

integer

Invoice ID

results.invoices.invoice_acceptance

object

Show child attributes

results.invoices.invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

results.invoices.invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

results.invoices.invoice_acceptance.accepted_by.first_name

string | null

First name of user

Maximum length: 64

results.invoices.invoice_acceptance.accepted_by.id

integer

User ID who accepted or rejected the invoice

results.invoices.invoice_acceptance.accepted_by.is_me

boolean

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

results.invoices.invoice_acceptance.accepted_by.last_name

string | null

Last name of user

Maximum length: 64

results.invoices.invoice_acceptance.accepted_by.photo_url

string

URL of the user photo

Minimum length: 1

results.invoices.invoice_acceptance.accepted_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

results.invoices.invoice_acceptance.accepted_by.status

enum<string>

User status

Available options:

active,

invited,

locked

results.invoices.invoice_acceptance.accepted_by.title

string | null

User title

Maximum length: 64

results.invoices.invoice_acceptance.accepted_by.type

enum<string>

User type

Available options:

standard,

api

results.invoices.invoice_acceptance.id

integer

Invoice acceptance ID

results.invoices.invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

results.invoices.invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

results.invoices.invoice_acceptance.rejected_by

object

Show child attributes

results.invoices.invoice_acceptance.rejected_by.first_name

string | null

First name of user

Maximum length: 64

results.invoices.invoice_acceptance.rejected_by.id

integer

User ID who accepted or rejected the invoice

results.invoices.invoice_acceptance.rejected_by.is_me

boolean

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

results.invoices.invoice_acceptance.rejected_by.last_name

string | null

Last name of user

Maximum length: 64

results.invoices.invoice_acceptance.rejected_by.photo_url

string

URL of the user photo

Minimum length: 1

results.invoices.invoice_acceptance.rejected_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

results.invoices.invoice_acceptance.rejected_by.status

enum<string>

User status

Available options:

active,

invited,

locked

results.invoices.invoice_acceptance.rejected_by.title

string | null

User title

Maximum length: 64

results.invoices.invoice_acceptance.rejected_by.type

enum<string>

User type

Available options:

standard,

api

results.invoices.invoice_lines

object[]

Show child attributes

results.invoices.invoice_lines.price

string

required

Discounted price

results.invoices.invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 < x < 2147483647

results.invoices.invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

results.invoices.invoice_lines.description

string | null

Product description

Maximum length: 128

results.invoices.invoice_lines.id

integer

Invoice line ID

results.invoices.invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 < x < 2147483647

results.invoices.invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

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

results.invoices.invoice_lines.name

string | null

Product name

Maximum length: 128

results.invoices.invoice_lines.retail_price

string

Retail price

results.invoices.invoice_lines.variant

object

Show child attributes

results.invoices.invoice_lines.variant.active_permit

object

Show child attributes

results.invoices.invoice_lines.variant.attributes

object[]

Show child attributes

results.invoices.invoice_lines.variant.brand

object

Show child attributes

results.invoices.invoice_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

results.invoices.invoice_lines.variant.cartons

object[]

Show child attributes

results.invoices.invoice_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

results.invoices.invoice_lines.variant.id

integer

Variant ID

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

results.invoices.invoice_lines.variant.inventory

object

Show child attributes

results.invoices.invoice_lines.variant.is_compatible

boolean

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

results.invoices.invoice_lines.variant.media

object[]

Show child attributes

results.invoices.invoice_lines.variant.name

string | null

Variant Name

Maximum length: 200

results.invoices.invoice_lines.variant.permits

object[]

Show child attributes

results.invoices.invoice_lines.variant.proposal_variant

object

Show child attributes

results.invoices.invoice_lines.variant.retailer_categories

object

Show child attributes

results.invoices.invoice_lines.variant.retailer_identifiers

object

Show child attributes

results.invoices.invoice_lines.variant.ruleset_variant_summary

string

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

results.invoices.invoice_lines.variant.ruleset_variants

object[]

Show child attributes

results.invoices.invoice_lines.variant.size

string | null

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

Maximum length: 128

results.invoices.invoice_lines.variant.style

string | null

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

Maximum length: 128

results.invoices.invoice_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

results.invoices.invoiced_at

string | null

Time of invoice creation (UTC format)

results.invoices.net_amount

string | null

Total invoice amount (exluding taxes)

results.invoices.notes

string | null

Addition info adding to shipping

results.invoices.order_id

integer

Order ID related to invoice

results.invoices.ordered_at

string | null

Time of order finalization (UTC format)

results.invoices.paid_at

string | null

Time of payment (UTC format)

results.invoices.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

results.invoices.remit_to

object

Show child attributes

results.invoices.remit_to.city

string

required

City name

Required string length: 1 - 64

results.invoices.remit_to.country

string

required

Country name

Required string length: 1 - 128

results.invoices.remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.invoices.remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.invoices.remit_to.province

string

required

State name

Required string length: 1 - 32

results.invoices.remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.invoices.remit_to.email

string | null

Contact email address

Maximum length: 128

results.invoices.remit_to.fax

string | null

Fax number

Maximum length: 32

results.invoices.remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.invoices.remit_to.id

integer

Address ID

results.invoices.remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.invoices.remit_to.phone1

string | null

Primary contact number

Maximum length: 32

results.invoices.remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.invoices.remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.invoices.remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.invoices.retailer

object

Show child attributes

results.invoices.retailer.code

string

required

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

Required string length: 1 - 32

results.invoices.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.invoices.retailer.brand_permit_creation_allowed

boolean

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

results.invoices.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.invoices.retailer.id

integer

Retailer ID

results.invoices.retailer.is_onboarded

boolean

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

results.invoices.retailer.is_rcn_retailer

boolean

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

results.invoices.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.invoices.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.invoices.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.invoices.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.invoices.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.invoices.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.invoices.retailer.website

string | null

Website URL

Maximum length: 100

results.invoices.ship_from

object

Show child attributes

results.invoices.ship_from.city

string

required

City name

Required string length: 1 - 64

results.invoices.ship_from.country

string

required

Country name

Required string length: 1 - 128

results.invoices.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.invoices.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

results.invoices.ship_from.province

string

required

State name

Required string length: 1 - 32

results.invoices.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.invoices.ship_from.email

string | null

Contact email address

Maximum length: 128

results.invoices.ship_from.fax

string | null

Fax number

Maximum length: 32

results.invoices.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.invoices.ship_from.id

integer

Address ID

results.invoices.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.invoices.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

results.invoices.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

results.invoices.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

results.invoices.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.invoices.ship_to

object

Show child attributes

results.invoices.ship_to.city

string

required

City name

Required string length: 1 - 64

results.invoices.ship_to.country

string

required

Country name

Required string length: 1 - 128

results.invoices.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.invoices.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.invoices.ship_to.province

string

required

State name

Required string length: 1 - 32

results.invoices.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.invoices.ship_to.email

string | null

Contact email address

Maximum length: 128

results.invoices.ship_to.fax

string | null

Fax number

Maximum length: 32

results.invoices.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.invoices.ship_to.id

integer

Address ID

results.invoices.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.invoices.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

results.invoices.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.invoices.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.invoices.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.invoices.shipped_at

string | null

Time of shipping (UTC format)

results.invoices.shipping_account_number

string | null

Shipping account number

Maximum length: 32

results.invoices.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

results.invoices.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

results.invoices.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

results.invoices.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

results.invoices.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

results.invoices.shipping_weight

string | null

Shipping weight

results.invoices.sold_to

object

Show child attributes

results.invoices.sold_to.city

string

required

City name

Required string length: 1 - 64

results.invoices.sold_to.country

string

required

Country name

Required string length: 1 - 128

results.invoices.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.invoices.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.invoices.sold_to.province

string

required

State name

Required string length: 1 - 32

results.invoices.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.invoices.sold_to.email

string | null

Contact email address

Maximum length: 128

results.invoices.sold_to.fax

string | null

Fax number

Maximum length: 32

results.invoices.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.invoices.sold_to.id

integer

Address ID

results.invoices.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.invoices.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

results.invoices.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.invoices.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.invoices.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.invoices.status

enum<string>

Invoice status

Available options:

closed,

open

results.invoices.subtotal

string | null

Sub-total

results.invoices.tax

string | null

Total tax on the invoice

results.invoices.terms_date_due

string | null

Payment expected date

results.invoices.terms_description

string | null

Description of invoice terms

results.invoices.terms_discount_percent

string | null

Discount percentage on selected term

results.invoices.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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

results.is_acknowledged

boolean

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

results.is_gift

boolean

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

results.is_on_hold

boolean

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

results.is_priority

boolean

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

results.is_replacement

boolean

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

results.memos

object[]

Show child attributes

results.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

results.memos.created_at

string

Time of memo creation (UTC format)

results.memos.created_by

object

Show child attributes

results.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

results.memos.created_by.id

integer

User ID who accepted or rejected the invoice

results.memos.created_by.is_me

boolean

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

results.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

results.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

results.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

results.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

results.memos.created_by.title

string | null

User title

Maximum length: 64

results.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

results.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

results.memos.id

integer

Memo ID

results.memos.notify_people

boolean

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

results.memos.text

string

Memo text

results.memos.updated_at

string

Time of memo update (UTC format)

results.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

results.memos_count

integer

Total memos

results.metadata

object[]

Show child attributes

results.metadata.created_at

string

Time of metadata creation (UTC format)

results.metadata.id

integer

Metadata ID

results.metadata.name

string

Metadata name

Minimum length: 1

results.metadata.type

string

Metadata type such as integer, float, etc.

Minimum length: 1

results.metadata.value

string | null

Metadata value, depending on the type

results.on_hold_at

string | null

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

results.on_hold_until

string | null

Date till when the order will be on hold

results.order_batches

object[]

Show child attributes

results.order_batches.id

integer

Batch ID of order

results.order_lines

object[]

Show child attributes

results.order_lines.ordered_at

string

required

Time of order finalization (UTC format)

results.order_lines.quantity

integer

required

Total products in the order

results.order_lines.backordered_until

string

Time till when product is backordered (UTC format)

results.order_lines.canceled_at

string | null

Time of cancellation (UTC format)

results.order_lines.estimated_price

string | null

Estimated price

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

results.order_lines.gift_fee

string | null

Gift fee

results.order_lines.id

integer

Order line ID

results.order_lines.metadata

object[]

Show child attributes

results.order_lines.metadata.created_at

string

Time of metadata creation (UTC format)

results.order_lines.metadata.id

integer

Metadata ID

results.order_lines.metadata.name

string

Metadata name

Minimum length: 1

results.order_lines.metadata.type

string

Metadata type such as integer, float, etc.

Minimum length: 1

results.order_lines.metadata.value

string | null

Metadata value, depending on the type

results.order_lines.net_price

string

Net price

results.order_lines.order_line_number

string

Order line number (auto-incremental number)

results.order_lines.packages_per_quantity

integer

Number of packages per quantity

results.order_lines.price

string

Discounted price

results.order_lines.quantity_canceled

string

Quantity cancelled

results.order_lines.quantity_invoiced

integer

Quantity invoiced

results.order_lines.quantity_open

integer

Quantity to be shipped

results.order_lines.quantity_returned

integer

Quantity returned

results.order_lines.quantity_shipped

integer

Quantity shipped

results.order_lines.shipping_charged

string

Shipping cost

results.order_lines.status

string

Order status

Minimum length: 1

results.order_lines.subtotal

string

Subtotal amount

results.order_lines.subtotal_charged

string

Subtotal charged

results.order_lines.tax_charged

string

Tax charged

results.order_lines.total_charge

string

Total charge

results.order_lines.variant

string

Details of product variant

results.pickup_on

string | null

Time of when order was picked up (UTC format)

results.priority_user

object

Show child attributes

results.priority_user.first_name

string | null

First name of user

Maximum length: 64

results.priority_user.id

integer

User ID who accepted or rejected the invoice

results.priority_user.is_me

boolean

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

results.priority_user.last_name

string | null

Last name of user

Maximum length: 64

results.priority_user.photo_url

string

URL of the user photo

Minimum length: 1

results.priority_user.profile_photo

string

URL of the user's profile photo

Minimum length: 1

results.priority_user.status

enum<string>

User status

Available options:

active,

invited,

locked

results.priority_user.title

string | null

User title

Maximum length: 64

results.priority_user.type

enum<string>

User type

Available options:

standard,

api

results.received_at

string

Time of when order was received (UTC format)

results.requested_shipping_method

object

Show child attributes

results.requested_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

results.requested_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

results.requested_shipping_method.id

integer

ID of shipping method

results.requested_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.requested_shipping_method_id

integer

ID of the requested shipping method

results.retailer

object

Show child attributes

results.retailer.code

string

required

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

Required string length: 1 - 32

results.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.retailer.brand_permit_creation_allowed

boolean

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

results.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.retailer.id

integer

Retailer ID

results.retailer.is_onboarded

boolean

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

results.retailer.is_rcn_retailer

boolean

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

results.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.retailer.website

string | null

Website URL

Maximum length: 100

results.retailer_order_number

string

Retailer order number

Minimum length: 1

results.return_to

object

Show child attributes

results.return_to.city

string

required

City name

Required string length: 1 - 64

results.return_to.country

string

required

Country name

Required string length: 1 - 128

results.return_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.return_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.return_to.province

string

required

State name

Required string length: 1 - 32

results.return_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.return_to.email

string | null

Contact email address

Maximum length: 128

results.return_to.fax

string | null

Fax number

Maximum length: 32

results.return_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.return_to.id

integer

Address ID

results.return_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.return_to.phone1

string | null

Primary contact number

Maximum length: 32

results.return_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.return_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.return_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.rmas

object[]

Show child attributes

results.rmas.order_id

integer

required

Order ID

results.rmas.reason_id

integer

required

ID associated with return reason

results.rmas.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

results.rmas.approved_at

string | null

Time of RMA approval (UTC format)

results.rmas.attachments

object[]

Show child attributes

results.rmas.attachments.content_type

integer

Content type

results.rmas.attachments.file

string | null

File name

results.rmas.attachments.filename

string | null

File name used for sharing

Maximum length: 255

results.rmas.attachments.id

integer

Attachment or document ID

results.rmas.attachments.object_id

integer

Attachement object ID

results.rmas.attachments.original_filename

string | null

Original file name

Maximum length: 255

results.rmas.attachments.tags

object[]

Show child attributes

results.rmas.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

results.rmas.attachments.tags.id

integer

Attachment tag ID

results.rmas.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

results.rmas.attachments.url

string

URL of attachment

Minimum length: 1

results.rmas.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

results.rmas.brand

object

Show child attributes

results.rmas.brand.code

string

required

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

Required string length: 1 - 64

results.rmas.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.rmas.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.rmas.brand.id

integer

Vendor (brand) ID

results.rmas.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.rmas.brand.is_on_rcn

boolean

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

results.rmas.brand.is_onboarded

boolean

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

results.rmas.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.rmas.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.rmas.brand.name

string

Vendor name

Required string length: 1 - 64

results.rmas.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.rmas.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.rmas.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.rmas.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.rmas.brand.subscription_is_delinquent

boolean

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

results.rmas.brand.subscription_is_expired

boolean

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

results.rmas.brand.subscription_is_on_grace_period

boolean

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

results.rmas.brand.website

string | null

URL of brand website

Maximum length: 100

results.rmas.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

results.rmas.credits

object[]

Show child attributes

results.rmas.credits.acknowledged_at

string | null

Time of credit acknowledgement

results.rmas.credits.adjustments

object[]

Show child attributes

results.rmas.credits.adjustments.description

string | null

Adjustment description

Maximum length: 128

results.rmas.credits.adjustments.id

integer

Adjustment ID

results.rmas.credits.adjustments.net_price

string

Adjustment net price

results.rmas.credits.brand

object

Show child attributes

results.rmas.credits.brand.code

string

required

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

Required string length: 1 - 64

results.rmas.credits.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.rmas.credits.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.rmas.credits.brand.id

integer

Vendor (brand) ID

results.rmas.credits.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.rmas.credits.brand.is_on_rcn

boolean

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

results.rmas.credits.brand.is_onboarded

boolean

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

results.rmas.credits.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.rmas.credits.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.rmas.credits.brand.name

string

Vendor name

Required string length: 1 - 64

results.rmas.credits.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.rmas.credits.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.rmas.credits.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.rmas.credits.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.rmas.credits.brand.subscription_is_delinquent

boolean

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

results.rmas.credits.brand.subscription_is_expired

boolean

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

results.rmas.credits.brand.subscription_is_on_grace_period

boolean

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

results.rmas.credits.brand.website

string | null

URL of brand website

Maximum length: 100

results.rmas.credits.created_at

string

Time of creation (UTC format)

results.rmas.credits.credit_amount

string

Credit amount

results.rmas.credits.credit_lines

object[]

Show child attributes

results.rmas.credits.credit_lines.quantity

integer

required

Quantity

Required range: -2147483648 < x < 2147483647

results.rmas.credits.credit_lines.id

integer

Credit line ID

results.rmas.credits.credit_lines.net_price

string

Credit line net price

results.rmas.credits.credit_lines.variant

object

Show child attributes

results.rmas.credits.credit_number

string | null

Credit number

Maximum length: 32

results.rmas.credits.credited_at

string | null

Time of credit (UTC format)

results.rmas.credits.currency

object

Show child attributes

results.rmas.credits.currency.id

integer

Currency ID

results.rmas.credits.currency.name

string

Currency name

Maximum length: 200

results.rmas.credits.currency.symbol

string | null

Currency symbol

Maximum length: 5

results.rmas.credits.currency.unit

string

Currency unit

results.rmas.credits.id

integer

Credit ID

results.rmas.credits.invoice

object

Show child attributes

results.rmas.credits.invoice.invoice_number

string

required

Invoice number

Required string length: 1 - 32

results.rmas.credits.invoice.acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

results.rmas.credits.invoice.allowances

object[]

Show child attributes

results.rmas.credits.invoice.brand

object

Show child attributes

results.rmas.credits.invoice.canceled_at

string | null

Time of order cancellation (UTC format)

results.rmas.credits.invoice.charges

object[]

Show child attributes

results.rmas.credits.invoice.closed_at

string | null

Time of complete invoice payment (UTC format)

results.rmas.credits.invoice.connection_id

string

Connection ID

results.rmas.credits.invoice.currency

object

Show child attributes

results.rmas.credits.invoice.customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

results.rmas.credits.invoice.due_amount

string | null

Pending amount

results.rmas.credits.invoice.expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

results.rmas.credits.invoice.id

integer

Invoice ID

results.rmas.credits.invoice.invoice_acceptance

object

Show child attributes

results.rmas.credits.invoice.invoice_lines

object[]

Show child attributes

results.rmas.credits.invoice.invoiced_at

string | null

Time of invoice creation (UTC format)

results.rmas.credits.invoice.net_amount

string | null

Total invoice amount (exluding taxes)

results.rmas.credits.invoice.notes

string | null

Addition info adding to shipping

results.rmas.credits.invoice.order_id

integer

Order ID related to invoice

results.rmas.credits.invoice.ordered_at

string | null

Time of order finalization (UTC format)

results.rmas.credits.invoice.paid_at

string | null

Time of payment (UTC format)

results.rmas.credits.invoice.purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

results.rmas.credits.invoice.remit_to

object

Show child attributes

results.rmas.credits.invoice.retailer

object

Show child attributes

results.rmas.credits.invoice.ship_from

object

Show child attributes

results.rmas.credits.invoice.ship_to

object

Show child attributes

results.rmas.credits.invoice.shipped_at

string | null

Time of shipping (UTC format)

results.rmas.credits.invoice.shipping_account_number

string | null

Shipping account number

Maximum length: 32

results.rmas.credits.invoice.shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

results.rmas.credits.invoice.shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

results.rmas.credits.invoice.shipping_method_code

string | null

Code of shipping method

Maximum length: 32

results.rmas.credits.invoice.shipping_method_name

string | null

Name of shipping method

Maximum length: 32

results.rmas.credits.invoice.shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

results.rmas.credits.invoice.shipping_weight

string | null

Shipping weight

results.rmas.credits.invoice.sold_to

object

Show child attributes

results.rmas.credits.invoice.status

enum<string>

Invoice status

Available options:

closed,

open

results.rmas.credits.invoice.subtotal

string | null

Sub-total

results.rmas.credits.invoice.tax

string | null

Total tax on the invoice

results.rmas.credits.invoice.terms_date_due

string | null

Payment expected date

results.rmas.credits.invoice.terms_description

string | null

Description of invoice terms

results.rmas.credits.invoice.terms_discount_percent

string | null

Discount percentage on selected term

results.rmas.credits.invoice.terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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

results.rmas.credits.order

string

Order details

results.rmas.credits.retailer

object

Show child attributes

results.rmas.credits.retailer.code

string

required

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

Required string length: 1 - 32

results.rmas.credits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

results.rmas.credits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.rmas.credits.retailer.id

integer

Retailer ID

results.rmas.credits.retailer.is_onboarded

boolean

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

results.rmas.credits.retailer.is_rcn_retailer

boolean

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

results.rmas.credits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.rmas.credits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.rmas.credits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.rmas.credits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.rmas.credits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.rmas.credits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.rmas.credits.retailer.website

string | null

Website URL

Maximum length: 100

results.rmas.credits.rma

object

Show child attributes

results.rmas.credits.rma.order_id

integer

required

Order ID

results.rmas.credits.rma.reason_id

integer

required

ID associated with return reason

results.rmas.credits.rma.acknowledged_at

string | null

Time of RMA acknowledgement (UTC format)

results.rmas.credits.rma.approved_at

string | null

Time of RMA approval (UTC format)

results.rmas.credits.rma.attachments

object[]

Show child attributes

results.rmas.credits.rma.brand

object

Show child attributes

results.rmas.credits.rma.created_by

enum<string> | null

User that initiated RMA

Available options:

retailer,

brand

results.rmas.credits.rma.credits

object[]

Show child attributes

results.rmas.credits.rma.currency

object

Show child attributes

results.rmas.credits.rma.id

integer

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

results.rmas.credits.rma.memos

object[]

Show child attributes

results.rmas.credits.rma.ordered_at

string

Time of order finalization (UTC format)

results.rmas.credits.rma.purchase_order_number

string

Purchase order number

Minimum length: 1

results.rmas.credits.rma.reason

string

Reason for return

Minimum length: 1

results.rmas.credits.rma.rejected_at

string | null

Time of RMA rejection(UTC format)

results.rmas.credits.rma.retailer

object

Show child attributes

results.rmas.credits.rma.rma_lines

object[]

Show child attributes

results.rmas.credits.rma.rma_number

string | null

RMA number

Maximum length: 32

results.rmas.credits.rma.rmad_at

string | null

Time of RMA creation (UTC format)

results.rmas.credits.rma.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

results.rmas.credits.rma.total_amount

string

Total amount

results.rmas.credits.subtotal

string

Subtotal amount

results.rmas.currency

object

Show child attributes

results.rmas.currency.id

integer

Currency ID

results.rmas.currency.name

string

Currency name

Maximum length: 200

results.rmas.currency.symbol

string | null

Currency symbol

Maximum length: 5

results.rmas.currency.unit

string

Currency unit

results.rmas.id

integer

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

results.rmas.memos

object[]

Show child attributes

results.rmas.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

results.rmas.memos.created_at

string

Time of memo creation (UTC format)

results.rmas.memos.created_by

object

Show child attributes

results.rmas.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

results.rmas.memos.created_by.id

integer

User ID who accepted or rejected the invoice

results.rmas.memos.created_by.is_me

boolean

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

results.rmas.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

results.rmas.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

results.rmas.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

results.rmas.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

results.rmas.memos.created_by.title

string | null

User title

Maximum length: 64

results.rmas.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

results.rmas.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

results.rmas.memos.id

integer

Memo ID

results.rmas.memos.notify_people

boolean

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

results.rmas.memos.text

string

Memo text

results.rmas.memos.updated_at

string

Time of memo update (UTC format)

results.rmas.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

results.rmas.ordered_at

string

Time of order finalization (UTC format)

results.rmas.purchase_order_number

string

Purchase order number

Minimum length: 1

results.rmas.reason

string

Reason for return

Minimum length: 1

results.rmas.rejected_at

string | null

Time of RMA rejection(UTC format)

results.rmas.retailer

object

Show child attributes

results.rmas.retailer.code

string

required

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

Required string length: 1 - 32

results.rmas.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.rmas.retailer.brand_permit_creation_allowed

boolean

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

results.rmas.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.rmas.retailer.id

integer

Retailer ID

results.rmas.retailer.is_onboarded

boolean

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

results.rmas.retailer.is_rcn_retailer

boolean

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

results.rmas.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.rmas.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.rmas.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.rmas.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.rmas.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.rmas.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.rmas.retailer.website

string | null

Website URL

Maximum length: 100

results.rmas.rma_lines

object[]

Show child attributes

results.rmas.rma_lines.id

integer

RMA line ID

results.rmas.rma_lines.net_price

string

Net price

results.rmas.rma_lines.quantity

integer

Total quantity

Required range: -2147483648 < x < 2147483647

results.rmas.rma_lines.quantity_shipped

integer

Quantity shipped

results.rmas.rma_lines.variant

object

Show child attributes

results.rmas.rma_lines.variant.active_permit

object

Show child attributes

results.rmas.rma_lines.variant.attributes

object[]

Show child attributes

results.rmas.rma_lines.variant.brand

object

Show child attributes

results.rmas.rma_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

results.rmas.rma_lines.variant.cartons

object[]

Show child attributes

results.rmas.rma_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

results.rmas.rma_lines.variant.id

integer

Variant ID

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

results.rmas.rma_lines.variant.inventory

object

Show child attributes

results.rmas.rma_lines.variant.is_compatible

boolean

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

results.rmas.rma_lines.variant.media

object[]

Show child attributes

results.rmas.rma_lines.variant.name

string | null

Variant Name

Maximum length: 200

results.rmas.rma_lines.variant.permits

object[]

Show child attributes

results.rmas.rma_lines.variant.proposal_variant

object

Show child attributes

results.rmas.rma_lines.variant.retailer_categories

object

Show child attributes

results.rmas.rma_lines.variant.retailer_identifiers

object

Show child attributes

results.rmas.rma_lines.variant.ruleset_variant_summary

string

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

results.rmas.rma_lines.variant.ruleset_variants

object[]

Show child attributes

results.rmas.rma_lines.variant.size

string | null

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

Maximum length: 128

results.rmas.rma_lines.variant.style

string | null

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

Maximum length: 128

results.rmas.rma_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

results.rmas.rma_number

string | null

RMA number

Maximum length: 32

results.rmas.rmad_at

string | null

Time of RMA creation (UTC format)

results.rmas.status

enum<string> | null

RMA status. Default is Pending.

Available options:

pending,

approved,

rejected

results.rmas.total_amount

string

Total amount

results.ship_from

object

Show child attributes

results.ship_from.city

string

required

City name

Required string length: 1 - 64

results.ship_from.country

string

required

Country name

Required string length: 1 - 128

results.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

results.ship_from.province

string

required

State name

Required string length: 1 - 32

results.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.ship_from.email

string | null

Contact email address

Maximum length: 128

results.ship_from.fax

string | null

Fax number

Maximum length: 32

results.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.ship_from.id

integer

Address ID

results.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

results.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

results.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

results.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.ship_to

object

Show child attributes

results.ship_to.city

string

required

City name

Required string length: 1 - 64

results.ship_to.country

string

required

Country name

Required string length: 1 - 128

results.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.ship_to.province

string

required

State name

Required string length: 1 - 32

results.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.ship_to.email

string | null

Contact email address

Maximum length: 128

results.ship_to.fax

string | null

Fax number

Maximum length: 32

results.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.ship_to.id

integer

Address ID

results.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

results.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.shipment_count

integer

Shipment count

results.shipments

object[]

Show child attributes

results.shipments.order_id

integer

required

Order ID

results.shipments.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.shipments.batch_number

integer | null

Batch number of shipment

Required range: -2147483648 < x < 2147483647

results.shipments.brand

object

Show child attributes

results.shipments.brand.code

string

required

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

Required string length: 1 - 64

results.shipments.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.shipments.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.shipments.brand.id

integer

Vendor (brand) ID

results.shipments.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.shipments.brand.is_on_rcn

boolean

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

results.shipments.brand.is_onboarded

boolean

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

results.shipments.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.shipments.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.shipments.brand.name

string

Vendor name

Required string length: 1 - 64

results.shipments.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.shipments.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.shipments.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.shipments.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.shipments.brand.subscription_is_delinquent

boolean

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

results.shipments.brand.subscription_is_expired

boolean

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

results.shipments.brand.subscription_is_on_grace_period

boolean

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

results.shipments.brand.website

string | null

URL of brand website

Maximum length: 100

results.shipments.canceled_at

string | null

Time of cancellation (UTC format)

results.shipments.closed_at

string | null

Time of shipment closure (UTC format)

results.shipments.created_at

string

Time of shipment creation (UTC format)

results.shipments.customer_order_number

string

Customer order number

Minimum length: 1

results.shipments.delivered_at

string | null

Time of delivery (UTC format)

results.shipments.error_logs

object

Show child attributes

results.shipments.error_logs.count

integer

Count of error log

results.shipments.error_logs.created_at

string

Time of error log creation

results.shipments.error_logs.id

integer

Error log ID

results.shipments.error_logs.message

string | null

Message in error log

results.shipments.has_commercial_invoice

boolean

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

results.shipments.id

integer

Shipment ID

results.shipments.invoice_number

string

Invoice number

results.shipments.is_acknowledged

boolean

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

results.shipments.label_reference

string | null

Label reference

Maximum length: 30

results.shipments.ordered_at

string

Time of shipment creation (UTC format)

results.shipments.purchase_order_number

string

Purchase order number

Minimum length: 1

results.shipments.retailer_order_number

string

Retailer order number

Minimum length: 1

results.shipments.ship_from

object

Show child attributes

results.shipments.ship_from.city

string

required

City name

Required string length: 1 - 64

results.shipments.ship_from.country

string

required

Country name

Required string length: 1 - 128

results.shipments.ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.shipments.ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

results.shipments.ship_from.province

string

required

State name

Required string length: 1 - 32

results.shipments.ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.shipments.ship_from.email

string | null

Contact email address

Maximum length: 128

results.shipments.ship_from.fax

string | null

Fax number

Maximum length: 32

results.shipments.ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.shipments.ship_from.id

integer

Address ID

results.shipments.ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.shipments.ship_from.phone1

string | null

Primary contact number

Maximum length: 32

results.shipments.ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

results.shipments.ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

results.shipments.ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.shipments.ship_girth

string

Shipment girth

results.shipments.ship_height

number | null

Shipment height

results.shipments.ship_length

number | null

Shipment length

results.shipments.ship_to

object

Show child attributes

results.shipments.ship_to.city

string

required

City name

Required string length: 1 - 64

results.shipments.ship_to.country

string

required

Country name

Required string length: 1 - 128

results.shipments.ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.shipments.ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.shipments.ship_to.province

string

required

State name

Required string length: 1 - 32

results.shipments.ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.shipments.ship_to.email

string | null

Contact email address

Maximum length: 128

results.shipments.ship_to.fax

string | null

Fax number

Maximum length: 32

results.shipments.ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.shipments.ship_to.id

integer

Address ID

results.shipments.ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.shipments.ship_to.phone1

string | null

Primary contact number

Maximum length: 32

results.shipments.ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.shipments.ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.shipments.ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.shipments.ship_volume

string

Shipment volume

results.shipments.ship_weight

number | null

Shipment weight

results.shipments.ship_width

number | null

Shipment width

results.shipments.shipment_lines

object[]

Show child attributes

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

results.shipments.shipment_lines.id

integer

Shipment line ID

results.shipments.shipment_lines.order_line_number

string

Order line number

results.shipments.shipment_lines.part

integer

Internal only

Required range: -2147483648 < x < 2147483647

results.shipments.shipment_lines.quantity

integer

Order quantity

Required range: -2147483648 < x < 2147483647

results.shipments.shipment_lines.updated_at

string

Time of last update

results.shipments.shipment_lines.variant

object

Show child attributes

results.shipments.shipment_lines.variant.brand

object

Show child attributes

results.shipments.shipment_lines.variant.brand_identifier

string

Brand identifier

Minimum length: 1

results.shipments.shipment_lines.variant.id

integer

Variant ID

results.shipments.shipment_lines.variant.identifier

string | null

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

Maximum length: 128

results.shipments.shipment_lines.variant.name

string | null

Variant name

Maximum length: 200

results.shipments.shipment_lines.variant.retailer_identifiers

object[]

Show child attributes

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

results.shipments.shipped_at

string | null

Time of shipping (UTC format)

results.shipments.shipping_account

object

Show child attributes

results.shipments.shipping_account.nickname

string

required

Nickname of shipping account

Required string length: 1 - 64

results.shipments.shipping_account.carrier

object

Show child attributes

results.shipments.shipping_account.carrier.code

string

Carrier code

Required string length: 1 - 64

results.shipments.shipping_account.carrier.id

integer

Carrier ID

results.shipments.shipping_account.carrier.name

string

Carrier name

Required string length: 1 - 64

results.shipments.shipping_account.id

integer

Shipping account ID

results.shipments.shipping_account.is_first_party_bill

boolean

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

results.shipments.shipping_account.owner

string

Owner of shipping account

results.shipments.shipping_method

object

Show child attributes

results.shipments.shipping_method.code

string

required

Code of shipping method

Required string length: 1 - 64

results.shipments.shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 64

results.shipments.shipping_method.carrier

object

Show child attributes

results.shipments.shipping_method.carrier.code

string

Carrier code

Required string length: 1 - 64

results.shipments.shipping_method.carrier.id

integer

Carrier ID

results.shipments.shipping_method.carrier.name

string

Carrier name

Required string length: 1 - 64

results.shipments.shipping_method.generic_shipping_method

object

Show child attributes

results.shipments.shipping_method.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

results.shipments.shipping_method.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

results.shipments.shipping_method.generic_shipping_method.id

integer

ID of shipping method

results.shipments.shipping_method.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.shipments.shipping_method.id

integer

ID of shipping method

results.shipments.shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.shipments.shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum length: 64

results.shipments.signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

results.shipments.sold_to

object

Show child attributes

results.shipments.sold_to.city

string

required

City name

Required string length: 1 - 64

results.shipments.sold_to.country

string

required

Country name

Required string length: 1 - 128

results.shipments.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.shipments.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.shipments.sold_to.province

string

required

State name

Required string length: 1 - 32

results.shipments.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.shipments.sold_to.email

string | null

Contact email address

Maximum length: 128

results.shipments.sold_to.fax

string | null

Fax number

Maximum length: 32

results.shipments.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.shipments.sold_to.id

integer

Address ID

results.shipments.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.shipments.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

results.shipments.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.shipments.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.shipments.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.shipments.status

string

Status of shipment

Minimum length: 1

results.shipments.tracking

object

Show child attributes

results.shipments.tracking.delivered_at

string | null

Time of order delivery

results.shipments.tracking.picked_up_at

string | null

Time of order pickup

results.shipments.tracking.tracking_details

object[]

Show child attributes

results.shipments.tracking.tracking_details.status

string

required

Tracking status

Required string length: 1 - 32

results.shipments.tracking.tracking_details.status_detail

string

required

Status details

Required string length: 1 - 64

results.shipments.tracking.tracking_details.Time

string

required

Time of tracking (UTC format)

results.shipments.tracking.tracking_details.city

string | null

City of delivery

Maximum length: 32

results.shipments.tracking.tracking_details.country

string | null

Country of delivery

Maximum length: 8

results.shipments.tracking.tracking_details.id

integer

Tracking ID

results.shipments.tracking.tracking_details.postal_code

string | null

Postal code for delivery

Maximum length: 16

results.shipments.tracking.tracking_details.state

string | null

State of delivery

Maximum length: 8

results.shipments.tracking_number

string | null

Tracking number for shipment

Maximum length: 128

results.shipments.tracking_url

string

URL for tracking shipment

results.shipments.updated_at

string

Time of shipment update (UTC format)

results.shipments.valid_packing_slip

boolean

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

results.shipments.valid_shipping_label

boolean

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

results.shipping_charged

string

Shipped charged

results.shipping_method

object

Show child attributes

results.shipping_method.code

string

required

Code of shipping method

Required string length: 1 - 64

results.shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 64

results.shipping_method.carrier

object

Show child attributes

results.shipping_method.carrier.code

string

Carrier code

Required string length: 1 - 64

results.shipping_method.carrier.id

integer

Carrier ID

results.shipping_method.carrier.name

string

Carrier name

Required string length: 1 - 64

results.shipping_method.generic_shipping_method

object

Show child attributes

results.shipping_method.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

results.shipping_method.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

results.shipping_method.generic_shipping_method.id

integer

ID of shipping method

results.shipping_method.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.shipping_method.id

integer

ID of shipping method

results.shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

results.signature

enum<string> | null

Represents whether signature is required

Available options:

required,

not_required,

adult

results.sold_to

object

Show child attributes

results.sold_to.city

string

required

City name

Required string length: 1 - 64

results.sold_to.country

string

required

Country name

Required string length: 1 - 128

results.sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

results.sold_to.province

string

required

State name

Required string length: 1 - 32

results.sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.sold_to.email

string | null

Contact email address

Maximum length: 128

results.sold_to.fax

string | null

Fax number

Maximum length: 32

results.sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.sold_to.id

integer

Address ID

results.sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.sold_to.phone1

string | null

Primary contact number

Maximum length: 32

results.sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

results.sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

results.sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.status

string

Order status

Minimum length: 1

results.subtotal_charged

string

Subtotal amount excluding shipping

results.tags

object[]

Show child attributes

results.tags.created_at

string

Time of object tag creation (UTC format)

results.tags.created_by

object

Show child attributes

results.tags.created_by.first_name

string | null

First name of user

Maximum length: 64

results.tags.created_by.id

integer

User ID who accepted or rejected the invoice

results.tags.created_by.is_me

boolean

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

results.tags.created_by.last_name

string | null

Last name of user

Maximum length: 64

results.tags.created_by.photo_url

string

URL of the user photo

Minimum length: 1

results.tags.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

results.tags.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

results.tags.created_by.title

string | null

User title

Maximum length: 64

results.tags.created_by.type

enum<string>

User type

Available options:

standard,

api

results.tags.id

integer

Object tag ID

results.tags.tag

string

Object tag

results.tags.updated_at

string

Time of last update (UTC format)

results.unread_memos_count

integer

Number of unread memos

results.updated_at

string

Time of order update (UTC format)

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)