Get details of a single invoice

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

Invoice ID

retailer_pk

number

required

Retailer ID

Response

invoice_number

string

required

Invoice number

Required string length: 1 - 32

Example:

"RC123456"

integer

Invoice ID

Example:

1

retailer

object

Show child attributes

retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

retailer.id

integer

Retailer ID

Example:

500

retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

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

retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

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

retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

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

retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

retailer.is_rcn_retailer

boolean

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

Example:

false

retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

retailer.brand_permit_creation_allowed

boolean

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

Example:

false

retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

brand

object

Show child attributes

brand.code

string<slug>

required

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

Required string length: 1 - 64

Example:

"demo-brand"

brand.id

integer

Vendor (brand) ID

Example:

500

brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

brand.joined_at

string<date-time>

Time when vendor joined Dropship (UTC format)

Example:

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

brand.logo_url

string<uri>

URL of the brand logo

Minimum string length: 1

Example:

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

brand.cover_url

string<uri>

URL of the cover image

Minimum string length: 1

Example:

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

brand.profile_tile_url

string<uri>

URL of the profile image

Minimum string length: 1

Example:

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

brand.website

string<uri> | null

URL of brand website

Maximum string length: 100

Example:

null

brand.is_onboarded

boolean

true: Vendor is onboarded
false: Vendor is not onboarded

Example:

false

brand.is_on_rcn

boolean

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

Example:

false

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

brand.subscription_expires_at

string<date-time> | null

Subscription expiry Time (UTC format)

Example:

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

brand.grace_period_ends_at

string<date-time> | null

Time of grace period expiration (UTC format)

Example:

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

brand.subscription_is_expired

boolean

true: subscription is expired
false: subscription is active

Example:

false

brand.subscription_is_on_grace_period

boolean

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

Example:

false

brand.subscription_is_delinquent

boolean

true: subscription is overdue
false: subscription is paid

Example:

false

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

connection_id

string

Connection ID

Example:

2

currency

object

Show child attributes

currency.id

integer

Currency ID

Example:

1

currency.name

string

Currency name

Maximum string length: 200

Example:

"United States Dollar"

currency.symbol

string | null

Currency symbol

Maximum string length: 5

Example:

"$"

currency.unit

string

Currency unit

Example:

"USD"

terms_type

enum<string> | null

Types of invoice terms

Available options:

End of Month (EOM),

No Charge,

Consignment,

10 Days After End of Month (10 EOM),

Cash Discount Terms Apply,

Basic,

Fixed Date, Late Payment Penalty Applies,

Extended,

Discount Not Applicable,

Fixed Date,

Previously agreed upon

Example:

"Previously agreed upon"

terms_description

string | null

Description of invoice terms

Example:

"Previously agreed upon terms will apply"

terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 <= x <= 2147483647

Example:

35

terms_date_due

string<date> | null

Payment expected date

Example:

null

terms_discount_percent

string<decimal> | null

Discount percentage on selected term

Example:

null

order_id

integer

Order ID related to invoice

Example:

"O-654"

customer_order_number

string | null

Customer order number (for enduser)

Maximum string length: 64

Example:

"CO-435"

purchase_order_number

string | null

Purchase order number (for retailer)

Maximum string length: 64

Example:

"PO-546"

status

enum<string>

Invoice status

Available options:

closed,

open

Example:

"closed"

remit_to

object

Show child attributes

remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

remit_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

remit_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

remit_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

remit_to.id

integer

Address ID

Example:

10

remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

remit_to.name2

string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

remit_to.street2

string | null

Line 2 of the address

Maximum string length: 128

Example:

null

remit_to.phone1

string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

remit_to.phone2

string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

remit_to.fax

string | null

Fax number

Maximum string length: 32

Example:

null

remit_to.email

string | null

Contact email address

Maximum string length: 128

Example:

null

remit_to.federal_tax_id

string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_from

object

Show child attributes

ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

ship_from.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

ship_from.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

ship_from.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

ship_from.id

integer

Address ID

Example:

10

ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

ship_from.name2

string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

ship_from.street2

string | null

Line 2 of the address

Maximum string length: 128

Example:

null

ship_from.phone1

string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

ship_from.phone2

string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

ship_from.fax

string | null

Fax number

Maximum string length: 32

Example:

null

ship_from.email

string | null

Contact email address

Maximum string length: 128

Example:

null

ship_from.federal_tax_id

string | null

Federal tax ID

Maximum string length: 32

Example:

null

sold_to

object

Show child attributes

sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

sold_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

sold_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

sold_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

sold_to.id

integer

Address ID

Example:

10

sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

sold_to.name2

string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

sold_to.street2

string | null

Line 2 of the address

Maximum string length: 128

Example:

null

sold_to.phone1

string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

sold_to.phone2

string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

sold_to.fax

string | null

Fax number

Maximum string length: 32

Example:

null

sold_to.email

string | null

Contact email address

Maximum string length: 128

Example:

null

sold_to.federal_tax_id

string | null

Federal tax ID

Maximum string length: 32

Example:

null

ship_to

object

Show child attributes

ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

ship_to.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

ship_to.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

ship_to.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

ship_to.id

integer

Address ID

Example:

10

ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

ship_to.name2

string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

ship_to.street2

string | null

Line 2 of the address

Maximum string length: 128

Example:

null

ship_to.phone1

string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

ship_to.phone2

string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

ship_to.fax

string | null

Fax number

Maximum string length: 32

Example:

null

ship_to.email

string | null

Contact email address

Maximum string length: 128

Example:

null

ship_to.federal_tax_id

string | null

Federal tax ID

Maximum string length: 32

Example:

null

shipping_carrier_name

string | null

Name of shipping carrier

Maximum string length: 32

Example:

"ALZ carrier"

shipping_carrier_code

string | null

Code of shipping carrier

Maximum string length: 32

Example:

"230F"

shipping_account_number

string | null

Shipping account number

Maximum string length: 32

Example:

"SH879"

shipping_method_name

string | null

Name of shipping method

Maximum string length: 32

Example:

"Next day delivery"

shipping_method_code

string | null

Code of shipping method

Maximum string length: 32

Example:

"ND"

shipping_tracking_number

string | null

Shipping tracking number

Maximum string length: 32

Example:

"1Z9999999999999988"

shipping_weight

string<decimal> | null

Shipping weight

Example:

"7.00"

notes

string | null

Addition info adding to shipping

Example:

"Signature required"

invoiced_at

string<date-time> | null

Time of invoice creation (UTC format)

Example:

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

ordered_at

string<date-time> | null

Time of order finalization (UTC format)

Example:

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

shipped_at

string<date-time> | null

Time of shipping (UTC format)

Example:

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

acknowledged_at

string<date-time> | null

Time of retailer acknowledgement (UTC format)

Example:

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

paid_at

string<date-time> | null

Time of payment (UTC format)

Example:

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

closed_at

string<date-time> | null

Time of complete invoice payment (UTC format)

Example:

null

canceled_at

string<date-time> | null

Time of order cancellation (UTC format)

Example:

null

allowances

object[]

Show child attributes

allowances.description

string

required

Description of allowance

Required string length: 1 - 128

Example:

"Sample-discount-allowance"

allowances.price

string<decimal>

required

Allowance price

Example:

"12.10"

allowances.id

integer

Allowance ID

Example:

1

allowances.adjustment_code

object

Show child attributes

allowances.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

allowances.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

allowances.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

allowances.adjustment_code.id

integer

Adjustment ID

Example:

1

charges

object[]

Show child attributes

charges.description

string

required

Invoice description

Required string length: 1 - 128

Example:

"Sample invoice and its description"

charges.price

string<decimal>

required

Invoice price

Example:

"23.45"

charges.id

integer

Invoice ID

Example:

654

charges.adjustment_code

object

Show child attributes

charges.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

charges.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

charges.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

charges.adjustment_code.id

integer

Adjustment ID

Example:

1

invoice_lines

object[]

Show child attributes

invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 <= x <= 2147483647

Example:

45

invoice_lines.price

string<decimal>

required

Discounted price

Example:

"12.00"

invoice_lines.id

integer

Invoice line ID

Example:

765

invoice_lines.variant

object

Show child attributes

invoice_lines.variant.id

integer

Variant ID

Example:

100024

invoice_lines.variant.name

string | null

Variant Name

Maximum string length: 200

Example:

"T-Shirt, Blue, L"

invoice_lines.variant.brand

object

Show child attributes

invoice_lines.variant.brand.code

string<slug>

required

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

Required string length: 1 - 64

Example:

"demo-brand"

invoice_lines.variant.brand.id

integer

Vendor (brand) ID

Example:

500

invoice_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

invoice_lines.variant.brand.joined_at

string<date-time>

Time when vendor joined Dropship (UTC format)

Example:

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

invoice_lines.variant.brand.logo_url

string<uri>

URL of the brand logo

Minimum string length: 1

Example:

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

invoice_lines.variant.brand.cover_url

string<uri>

URL of the cover image

Minimum string length: 1

Example:

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

invoice_lines.variant.brand.profile_tile_url

string<uri>

URL of the profile image

Minimum string length: 1

Example:

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

invoice_lines.variant.brand.website

string<uri> | null

URL of brand website

Maximum string length: 100

Example:

null

invoice_lines.variant.brand.is_onboarded

boolean

true: Vendor is onboarded
false: Vendor is not onboarded

Example:

false

invoice_lines.variant.brand.is_on_rcn

boolean

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

Example:

false

invoice_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

invoice_lines.variant.brand.subscription_expires_at

string<date-time> | null

Subscription expiry Time (UTC format)

Example:

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

invoice_lines.variant.brand.grace_period_ends_at

string<date-time> | null

Time of grace period expiration (UTC format)

Example:

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

invoice_lines.variant.brand.subscription_is_expired

boolean

true: subscription is expired
false: subscription is active

Example:

false

invoice_lines.variant.brand.subscription_is_on_grace_period

boolean

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

Example:

false

invoice_lines.variant.brand.subscription_is_delinquent

boolean

true: subscription is overdue
false: subscription is paid

Example:

false

invoice_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

invoice_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

invoice_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum string length: 1

Example:

"1000-BL-L"

invoice_lines.variant.identifier

string | null

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

Maximum string length: 128

Example:

"5000001"

invoice_lines.variant.upc

string

UPC or other GTIN

Maximum string length: 64

Example:

9119119111

invoice_lines.variant.cartons

object[]

Show child attributes

invoice_lines.variant.cartons.id

integer

Carton ID

Example:

48

invoice_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

invoice_lines.variant.cartons.length

string<decimal> | null

Carton length

Example:

"1"

invoice_lines.variant.cartons.length_unit

string

Unit of length

Example:

"1"

invoice_lines.variant.cartons.width

string<decimal> | null

Carton width

Example:

"1"

invoice_lines.variant.cartons.width_unit

string

Unit of width

Example:

"meter"

invoice_lines.variant.cartons.height

string<decimal> | null

Carton height

Example:

"1"

invoice_lines.variant.cartons.height_unit

string

Unit of height

Example:

"meter"

invoice_lines.variant.cartons.weight

string<decimal> | null

Carton weight

Example:

"15"

invoice_lines.variant.cartons.weight_unit

string

Unit of weight

Example:

"KG"

invoice_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

Example:

"1"

invoice_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

Example:

"1"

invoice_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum string length: 128

Example:

"Red"

invoice_lines.variant.style

string | null

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

Maximum string length: 128

Example:

"Print"

invoice_lines.variant.size

string | null

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

Maximum string length: 128

Example:

"Large"

invoice_lines.variant.media

object[]

Show child attributes

invoice_lines.variant.media.id

integer

Variant ID

Example:

249

invoice_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

invoice_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

invoice_lines.variant.media.media

string

Variant images

Example:

"default"

invoice_lines.variant.media.priority

integer

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

Required range: -2147483648 <= x <= 2147483647

Example:

1

invoice_lines.variant.media.url

string

URL of variant image

Example:

"192.168.99.100/media/default/original"

invoice_lines.variant.media.updated_at

string<date-time>

Time of variant image update (UTC format)

Example:

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

invoice_lines.variant.media.created_at

string<date-time>

Time of variant image creation (UTC format)

Example:

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

invoice_lines.variant.attributes

object[]

Show child attributes

invoice_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"size"

invoice_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Size"

invoice_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

invoice_lines.variant.attributes.id

integer

Attribute ID

Example:

44

invoice_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

invoice_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"general"

invoice_lines.variant.attributes.description

string | null

Attribute description

Example:

"demo product description"

invoice_lines.variant.attributes.units

string | null

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

Maximum string length: 32

Example:

"USD"

invoice_lines.variant.attributes.values

object

Show child attributes

invoice_lines.variant.attributes.values.id

integer

Attribute value ID

invoice_lines.variant.attributes.values.value

string

Attribute value

invoice_lines.variant.attributes.values.unit

object

Show child attributes

invoice_lines.variant.attributes.values.unit.id

integer

Unit ID

Example:

677

invoice_lines.variant.attributes.values.unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

invoice_lines.variant.attributes.values.unit.standard_unit

string

Standard unit

Minimum string length: 1

invoice_lines.variant.attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

invoice_lines.variant.attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

invoice_lines.variant.attributes.values.unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

invoice_lines.variant.attributes.values.retailer

object

Show child attributes

invoice_lines.variant.attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

invoice_lines.variant.attributes.values.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

invoice_lines.variant.attributes.values.retailer.id

integer

Retailer ID

Example:

500

invoice_lines.variant.attributes.values.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

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

invoice_lines.variant.attributes.values.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

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

invoice_lines.variant.attributes.values.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

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

invoice_lines.variant.attributes.values.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

invoice_lines.variant.attributes.values.retailer.is_rcn_retailer

boolean

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

Example:

false

invoice_lines.variant.attributes.values.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

invoice_lines.variant.attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

invoice_lines.variant.attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

invoice_lines.variant.attributes.values.retailer.brand_permit_creation_allowed

boolean

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

Example:

false

invoice_lines.variant.attributes.values.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

invoice_lines.variant.attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

invoice_lines.variant.attributes.values.updated_at

string<date-time>

Time of update

invoice_lines.variant.attributes.values.created_at

string<date-time>

Time of creation

invoice_lines.variant.ruleset_variants

object[]

Show child attributes

invoice_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

Example:

1232

invoice_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

invoice_lines.variant.ruleset_variants.ruleset

any

invoice_lines.variant.ruleset_variants.results

string

Response

invoice_lines.variant.ruleset_variants.created_at

string<date-time>

Time of creation (UTC format)

Example:

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

invoice_lines.variant.ruleset_variants.updated_at

string<date-time>

Time of last update (UTC format)

Example:

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

invoice_lines.variant.ruleset_variant_summary

string

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

Example:

"21"

invoice_lines.variant.active_permit

object

Show child attributes

invoice_lines.variant.active_permit.id

integer

Permit ID

Example:

10104

invoice_lines.variant.active_permit.retailer

object

Show child attributes

invoice_lines.variant.active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

invoice_lines.variant.active_permit.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

invoice_lines.variant.active_permit.retailer.id

integer

Retailer ID

Example:

500

invoice_lines.variant.active_permit.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

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

invoice_lines.variant.active_permit.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

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

invoice_lines.variant.active_permit.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

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

invoice_lines.variant.active_permit.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

invoice_lines.variant.active_permit.retailer.is_rcn_retailer

boolean

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

Example:

false

invoice_lines.variant.active_permit.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

invoice_lines.variant.active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

invoice_lines.variant.active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

invoice_lines.variant.active_permit.retailer.brand_permit_creation_allowed

boolean

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

Example:

false

invoice_lines.variant.active_permit.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

invoice_lines.variant.active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

invoice_lines.variant.active_permit.retailer_price

string<decimal> | null

Retailer price of the variant

Example:

"12.99"

invoice_lines.variant.active_permit.retailer_cost

string<decimal> | null

Retailer cost of variant

Example:

"8.99"

invoice_lines.variant.active_permit.pricing

object

invoice_lines.variant.active_permit.attributes

object

invoice_lines.variant.active_permit.start_at

string<date-time> | null

Time of permit start (UTC format)

Example:

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

invoice_lines.variant.active_permit.end_at

string<date-time> | null

Time of permit end (UTC format)

Example:

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

invoice_lines.variant.active_permit.is_in_effect

boolean

true: permit is in effect
false: permit is not in effect

Example:

true

invoice_lines.variant.active_permit.revoked_at

string<date-time> | null

Time when permit got revoked (UTC format)

Example:

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

invoice_lines.variant.active_permit.is_acknowledged

boolean

true: permit is acknowledged
false: permit is not acknowledged

Example:

true

invoice_lines.variant.active_permit.acknowledged_at

string<date-time> | null

Time of acknowledgement (UTC format)

Example:

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

invoice_lines.variant.permits

object[]

Show child attributes

invoice_lines.variant.permits.id

integer

Permit ID

Example:

10104

invoice_lines.variant.permits.retailer

object

Show child attributes

invoice_lines.variant.permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

invoice_lines.variant.permits.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

invoice_lines.variant.permits.retailer.id

integer

Retailer ID

Example:

500

invoice_lines.variant.permits.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

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

invoice_lines.variant.permits.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

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

invoice_lines.variant.permits.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

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

invoice_lines.variant.permits.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

invoice_lines.variant.permits.retailer.is_rcn_retailer

boolean

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

Example:

false

invoice_lines.variant.permits.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

invoice_lines.variant.permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

invoice_lines.variant.permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

invoice_lines.variant.permits.retailer.brand_permit_creation_allowed

boolean

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

Example:

false

invoice_lines.variant.permits.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

invoice_lines.variant.permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

invoice_lines.variant.permits.retailer_price

string<decimal> | null

Retailer price of the variant

Example:

"12.99"

invoice_lines.variant.permits.retailer_cost

string<decimal> | null

Retailer cost of variant

Example:

"8.99"

invoice_lines.variant.permits.pricing

object

invoice_lines.variant.permits.attributes

object

invoice_lines.variant.permits.start_at

string<date-time> | null

Time of permit start (UTC format)

Example:

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

invoice_lines.variant.permits.end_at

string<date-time> | null

Time of permit end (UTC format)

Example:

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

invoice_lines.variant.permits.is_in_effect

boolean

true: permit is in effect
false: permit is not in effect

Example:

true

invoice_lines.variant.permits.revoked_at

string<date-time> | null

Time when permit got revoked (UTC format)

Example:

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

invoice_lines.variant.permits.is_acknowledged

boolean

true: permit is acknowledged
false: permit is not acknowledged

Example:

true

invoice_lines.variant.permits.acknowledged_at

string<date-time> | null

Time of acknowledgement (UTC format)

Example:

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

invoice_lines.variant.is_compatible

boolean

true: variant meets requirement
false: variant doesn not meet requirement

Example:

true

invoice_lines.variant.proposal_variant

object

Show child attributes

invoice_lines.variant.proposal_variant.id

integer

Proposal variant ID

Example:

3456

invoice_lines.variant.proposal_variant.pricing

string

Pricing of variant

Example:

"12.00"

invoice_lines.variant.proposal_variant.attributes

object[]

Show child attributes

invoice_lines.variant.proposal_variant.attributes.id

integer

Attribute value ID

invoice_lines.variant.proposal_variant.attributes.value

string

Attribute value

invoice_lines.variant.proposal_variant.attributes.unit

object

Show child attributes

invoice_lines.variant.proposal_variant.attributes.unit.id

integer

Unit ID

Example:

677

invoice_lines.variant.proposal_variant.attributes.unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

invoice_lines.variant.proposal_variant.attributes.unit.standard_unit

string

Standard unit

Minimum string length: 1

invoice_lines.variant.proposal_variant.attributes.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

invoice_lines.variant.proposal_variant.attributes.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

invoice_lines.variant.proposal_variant.attributes.unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

invoice_lines.variant.proposal_variant.attributes.retailer

object

Show child attributes

invoice_lines.variant.proposal_variant.attributes.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

invoice_lines.variant.proposal_variant.attributes.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

invoice_lines.variant.proposal_variant.attributes.retailer.id

integer

Retailer ID

Example:

500

invoice_lines.variant.proposal_variant.attributes.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

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

invoice_lines.variant.proposal_variant.attributes.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

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

invoice_lines.variant.proposal_variant.attributes.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

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

invoice_lines.variant.proposal_variant.attributes.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.attributes.retailer.is_rcn_retailer

boolean

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

Example:

false

invoice_lines.variant.proposal_variant.attributes.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

invoice_lines.variant.proposal_variant.attributes.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

invoice_lines.variant.proposal_variant.attributes.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

invoice_lines.variant.proposal_variant.attributes.retailer.brand_permit_creation_allowed

boolean

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

Example:

false

invoice_lines.variant.proposal_variant.attributes.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

invoice_lines.variant.proposal_variant.attributes.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

invoice_lines.variant.proposal_variant.attributes.updated_at

string<date-time>

Time of update

invoice_lines.variant.proposal_variant.attributes.created_at

string<date-time>

Time of creation

invoice_lines.variant.proposal_variant.memos

object[]

Show child attributes

invoice_lines.variant.proposal_variant.memos.id

integer

Memo ID

Example:

1234

invoice_lines.variant.proposal_variant.memos.text

string

Memo text

Example:

"Immediate requirement"

invoice_lines.variant.proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

invoice_lines.variant.proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.memos.notify_people

boolean

true: notify stakeholders
false: do not notify

Example:

true

invoice_lines.variant.proposal_variant.memos.created_by

object

Show child attributes

invoice_lines.variant.proposal_variant.memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

invoice_lines.variant.proposal_variant.memos.created_by.first_name

string | null

First name of user

Maximum string length: 64

Example:

"Sample"

invoice_lines.variant.proposal_variant.memos.created_by.last_name

string | null

Last name of user

Maximum string length: 64

Example:

"Demo"

invoice_lines.variant.proposal_variant.memos.created_by.title

string | null

User title

Maximum string length: 64

Example:

"Demo"

invoice_lines.variant.proposal_variant.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

invoice_lines.variant.proposal_variant.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

invoice_lines.variant.proposal_variant.memos.created_by.photo_url

string<uri>

URL of the user photo

Minimum string length: 1

Example:

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

invoice_lines.variant.proposal_variant.memos.created_by.profile_photo

string<uri>

URL of the user's profile photo

Minimum string length: 1

Example:

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

invoice_lines.variant.proposal_variant.memos.created_by.is_me

boolean

true: user is me:
false: user is not me

Example:

true

invoice_lines.variant.proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

invoice_lines.variant.proposal_variant.memos.created_at

string<date-time>

Time of memo creation (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.memos.updated_at

string<date-time>

Time of memo update (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.issues

object[]

Show child attributes

invoice_lines.variant.proposal_variant.issues.id

integer

Issue ID

invoice_lines.variant.proposal_variant.issues.memos

object[]

Show child attributes

invoice_lines.variant.proposal_variant.issues.memos.id

integer

Memo ID

Example:

1234

invoice_lines.variant.proposal_variant.issues.memos.text

string

Memo text

Example:

"Immediate requirement"

invoice_lines.variant.proposal_variant.issues.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

invoice_lines.variant.proposal_variant.issues.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.issues.memos.notify_people

boolean

true: notify stakeholders
false: do not notify

Example:

true

invoice_lines.variant.proposal_variant.issues.memos.created_by

object

Show child attributes

invoice_lines.variant.proposal_variant.issues.memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

invoice_lines.variant.proposal_variant.issues.memos.created_by.first_name

string | null

First name of user

Maximum string length: 64

Example:

"Sample"

invoice_lines.variant.proposal_variant.issues.memos.created_by.last_name

string | null

Last name of user

Maximum string length: 64

Example:

"Demo"

invoice_lines.variant.proposal_variant.issues.memos.created_by.title

string | null

User title

Maximum string length: 64

Example:

"Demo"

invoice_lines.variant.proposal_variant.issues.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

invoice_lines.variant.proposal_variant.issues.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

invoice_lines.variant.proposal_variant.issues.memos.created_by.photo_url

string<uri>

URL of the user photo

Minimum string length: 1

Example:

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

invoice_lines.variant.proposal_variant.issues.memos.created_by.profile_photo

string<uri>

URL of the user's profile photo

Minimum string length: 1

Example:

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

invoice_lines.variant.proposal_variant.issues.memos.created_by.is_me

boolean

true: user is me:
false: user is not me

Example:

true

invoice_lines.variant.proposal_variant.issues.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

invoice_lines.variant.proposal_variant.issues.memos.created_at

string<date-time>

Time of memo creation (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.issues.memos.updated_at

string<date-time>

Time of memo update (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.issues.created_at

string<date-time>

Time of issue creation

invoice_lines.variant.proposal_variant.issues.updated_at

string<date-time>

Time of issue update

invoice_lines.variant.proposal_variant.issues.resolved_at

string<date-time>

Time of issue resolution

invoice_lines.variant.proposal_variant.issues.is_resolved

string

true: Issue is resolved
false: Issue is not resolved

invoice_lines.variant.proposal_variant.issues.issue_id

integer

Issue ID

invoice_lines.variant.proposal_variant.issues.message

string

Description or note related to issue

Minimum string length: 1

invoice_lines.variant.proposal_variant.issues.title

string

Issue title

Minimum string length: 1

invoice_lines.variant.proposal_variant.variant_id

integer

Variant ID

Example:

249

invoice_lines.variant.proposal_variant.approved_at

string<date-time> | null

Time of approval (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.created_at

string<date-time>

Time of creation (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.updated_at

string<date-time>

Time of last update (UTC format)

Example:

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

invoice_lines.variant.proposal_variant.rejected_at

string<date-time> | null

Time of proposal rejection (UTC format)

Example:

null

invoice_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum string length: 32

Example:

"Incomplete"

invoice_lines.variant.proposal_variant.reject

boolean

true: proposal is rejected
false: proposal is not rejected

Example:

true

invoice_lines.variant.proposal_variant.approve

boolean

true: proposal is approved
false: proposal is not approved

Example:

false

invoice_lines.variant.proposal_variant.delete

boolean

true: proposal is deleted
false: proposal is not deleted

Example:

false

invoice_lines.variant.retailer_identifiers

object

Show child attributes

invoice_lines.variant.retailer_identifiers.id

integer

Retailer ID

Example:

5642

invoice_lines.variant.retailer_identifiers.retailer

object

Show child attributes

invoice_lines.variant.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

invoice_lines.variant.retailer_identifiers.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

invoice_lines.variant.retailer_identifiers.retailer.id

integer

Retailer ID

Example:

500

invoice_lines.variant.retailer_identifiers.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

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

invoice_lines.variant.retailer_identifiers.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

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

invoice_lines.variant.retailer_identifiers.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

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

invoice_lines.variant.retailer_identifiers.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

invoice_lines.variant.retailer_identifiers.retailer.is_rcn_retailer

boolean

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

Example:

false

invoice_lines.variant.retailer_identifiers.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

invoice_lines.variant.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

invoice_lines.variant.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

invoice_lines.variant.retailer_identifiers.retailer.brand_permit_creation_allowed

boolean

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

Example:

false

invoice_lines.variant.retailer_identifiers.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

invoice_lines.variant.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

invoice_lines.variant.retailer_identifiers.identifier

string | null

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

Maximum string length: 256

Example:

"SKU976"

invoice_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum string length: 256

Example:

"Retailer Sample"

invoice_lines.variant.retailer_categories

object

Show child attributes

invoice_lines.variant.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

invoice_lines.variant.retailer_categories.id

integer

Retailer category ID

Example:

453

invoice_lines.variant.retailer_categories.retailer

object

Show child attributes

invoice_lines.variant.retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

invoice_lines.variant.retailer_categories.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

invoice_lines.variant.retailer_categories.retailer.id

integer

Retailer ID

Example:

500

invoice_lines.variant.retailer_categories.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

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

invoice_lines.variant.retailer_categories.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

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

invoice_lines.variant.retailer_categories.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

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

invoice_lines.variant.retailer_categories.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

invoice_lines.variant.retailer_categories.retailer.is_rcn_retailer

boolean

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

Example:

false

invoice_lines.variant.retailer_categories.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

invoice_lines.variant.retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

invoice_lines.variant.retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

invoice_lines.variant.retailer_categories.retailer.brand_permit_creation_allowed

boolean

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

Example:

false

invoice_lines.variant.retailer_categories.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

invoice_lines.variant.retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

invoice_lines.variant.inventory

object

Show child attributes

invoice_lines.variant.inventory.inventory_updated_at

string<date-time>

required

Time of inventory update (UTC format)

Example:

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

invoice_lines.variant.inventory.inventory_last_submitted_at

string<date-time>

required

Time of inventory submit (UTC format)

Example:

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

invoice_lines.variant.inventory.brand_inventory_updated_at

string<date-time>

required

Time of vendor inventory update (UTC format)

Example:

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

invoice_lines.variant.inventory.sellable_updated_at

string<date-time>

required

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

Example:

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

invoice_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum string length: 1

Example:

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

invoice_lines.variant.inventory.discontinued

boolean

true: Product is discontinued
false: Product is active

Example:

true

invoice_lines.variant.inventory.discontinued_updated_at

string<date-time>

Time of when product inventory was discontinued (UTC format)

Example:

null

invoice_lines.variant.inventory.inventory

integer

Inventory of variant

Example:

0

invoice_lines.variant.inventory.sellable

string

yes: Variant is sellable
No: Variant is not sellable

Example:

"No"

invoice_lines.variant.inventory.replenishable

boolean

true: product is replenishable
false: product is not replenishable

Example:

true

invoice_lines.variant.inventory.locations

object[]

Show child attributes

invoice_lines.variant.inventory.locations.id

integer

Location ID

Example:

1

invoice_lines.variant.inventory.locations.address

object

Show child attributes

invoice_lines.variant.inventory.locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

invoice_lines.variant.inventory.locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

invoice_lines.variant.inventory.locations.address.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

invoice_lines.variant.inventory.locations.address.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

invoice_lines.variant.inventory.locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

invoice_lines.variant.inventory.locations.address.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

invoice_lines.variant.inventory.locations.address.id

integer

Address ID

Example:

10

invoice_lines.variant.inventory.locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

invoice_lines.variant.inventory.locations.address.name2

string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

invoice_lines.variant.inventory.locations.address.street2

string | null

Line 2 of the address

Maximum string length: 128

Example:

null

invoice_lines.variant.inventory.locations.address.phone1

string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

invoice_lines.variant.inventory.locations.address.phone2

string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

invoice_lines.variant.inventory.locations.address.fax

string | null

Fax number

Maximum string length: 32

Example:

null

invoice_lines.variant.inventory.locations.address.email

string | null

Contact email address

Maximum string length: 128

Example:

null

invoice_lines.variant.inventory.locations.address.federal_tax_id

string | null

Federal tax ID

Maximum string length: 32

Example:

null

invoice_lines.variant.inventory.locations.inventory

integer

Count of sellable variants

Example:

0

invoice_lines.variant.inventory.locations.nickname

string

Nickname of location

Example:

"LA Warehouse"

invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 <= x <= 2147483647

Example:

2

invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum string length: 128

Example:

"Vend134"

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

Example:

"911911911112"

invoice_lines.name

string | null

Product name

Maximum string length: 128

Example:

"SamPro1"

invoice_lines.description

string | null

Product description

Maximum string length: 128

Example:

"Sample description of product"

invoice_lines.canceled_at

string<date-time> | null

Time of cancellation (UTC format)

Example:

null

invoice_lines.retail_price

string<decimal>

Retail price

Example:

"14.00"

net_amount

string<decimal> | null

Total invoice amount (exluding taxes)

Example:

"12.89"

due_amount

string<decimal> | null

Pending amount

Example:

"2.89"

expected_due_amount

string<decimal> | null

Expected due amount (excluding allowances and charges)

Example:

"2.89"

subtotal

string<decimal> | null

Sub-total

Example:

"10.89"

tax

string<decimal> | null

Total tax on the invoice

Example:

"2.00"

invoice_acceptance

object

Show child attributes

invoice_acceptance.id

integer

Invoice acceptance ID

Example:

565

invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

invoice_acceptance.accepted_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

invoice_acceptance.accepted_by.first_name

string | null

First name of user

Maximum string length: 64

Example:

"Sample"

invoice_acceptance.accepted_by.last_name

string | null

Last name of user

Maximum string length: 64

Example:

"Demo"

invoice_acceptance.accepted_by.title

string | null

User title

Maximum string length: 64

Example:

"Demo"

invoice_acceptance.accepted_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

invoice_acceptance.accepted_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

invoice_acceptance.accepted_by.photo_url

string<uri>

URL of the user photo

Minimum string length: 1

Example:

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

invoice_acceptance.accepted_by.profile_photo

string<uri>

URL of the user's profile photo

Minimum string length: 1

Example:

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

invoice_acceptance.accepted_by.is_me

boolean

true: user is me:
false: user is not me

Example:

true

invoice_acceptance.rejected_by

object

Show child attributes

invoice_acceptance.rejected_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

invoice_acceptance.rejected_by.first_name

string | null

First name of user

Maximum string length: 64

Example:

"Sample"

invoice_acceptance.rejected_by.last_name

string | null

Last name of user

Maximum string length: 64

Example:

"Demo"

invoice_acceptance.rejected_by.title

string | null

User title

Maximum string length: 64

Example:

"Demo"

invoice_acceptance.rejected_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

invoice_acceptance.rejected_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

invoice_acceptance.rejected_by.photo_url

string<uri>

URL of the user photo

Minimum string length: 1

Example:

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

invoice_acceptance.rejected_by.profile_photo

string<uri>

URL of the user's profile photo

Minimum string length: 1

Example:

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

invoice_acceptance.rejected_by.is_me

boolean

true: user is me:
false: user is not me

Example:

true

invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum string length: 128

Example:

"Incorrect"

invoice_acceptance.accepted_at

string<date-time> | null

Time of invoice acceptance (UTC format)

Example:

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

invoice_acceptance.rejected_at

string<date-time> | null

Time of invoice rejection (UTC format)

Example:

null

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get details of a single invoice

Authorizations

Path Parameters

Response