List invoices from vendors

Gets a list of invoices from vendors

Authorizations

Authorization · string · header · required

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

Path Parameters

retailer_id · number · required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Query Parameters

search · string

Search by invoice or purchase order number

is_acknowledged · number

1: Acknowledged invoices | 0: Unacknowledged invoices

is_paid · number

1: Paid invoices |0: Unpaid invoices

invoiced_at_lt · number

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

invoiced_at_lte · number

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

invoiced_at_gt · number

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

invoiced_at_gte · number

Invoice date is greater than or equal to specified unix Time

terms_date_due_lt · number

Invoice due date is less than specified Time (Unix epoch format)

terms_date_due_lte · number

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

terms_date_due_gt · number

Invoice due date is greater than specified Time (Unix epoch format)

terms_date_due_gte · number

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

connection_id · number[]

Connection ID. Multiple values may be separated by commas.

brand_id · number[]

Vendor IDs. Multiple values may be separated by commas.

retailer_id · number[]

Retailer IDs. Multiple values may be separated by commas.

payment_id · number[]

Payment IDs. Multiple values may be separated by commas.

has_payment · number

1: Invoice is paid |0: Invoice is unpaid

purchase_order_number · string

Purchase order number

total_due_lt · number

Total due amount is less than the specified amount

total_due_lte · number

Total due amount is less than or equal to the specified amount

total_due_gt · number

Total due amount is greater than the specified amount

total_due_gte · number

Total due amount is greater than or equal to the specified amount

paid_at_lt · number

Date paid is less than specified Time (Unix epoch format)

paid_at_lte · number

Date paid is less than or equal to specified Time (Unix epoch format)

paid_at_gt · number

Date paid is greater than specified Time (Unix epoch format)

paid_at_gte · number

Date paid is greater than or equal to specified Time (Unix epoch format)

order_closed_at_lt · number

Order close date is less than specified Time (Unix epoch format).

order_closed_at_lte · number

Order close date is less than or equal to specified Time (Unix epoch format).

order_closed_at_gt · number

Order close date is greater than specified Time (Unix epoch format)

order_closed_at_gte · number

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

order_by · string

Sorting preference

page · integer

Page number within the paginated response

limit · integer

Number of records per page

Response

200 - application/json

OK

count · integer · required

Total number of records

Example:

100

results · object[] · required

Show child attributes

results. invoice_number · string · required

Invoice number

Required string length: 1 - 32

Example:

"RC123456"

results. id · integer

Invoice ID

Example:

1

results. retailer · object

Show child attributes

results.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

results.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

results.retailer. id · integer

Retailer ID

Example:

500

results.retailer. logo_url · string

URL of retailer logo

Minimum length: 1

Example:

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

results.retailer. cover_url · string

URL of retailer cover image

Minimum length: 1

Example:

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

results.retailer. profile_tile_url · string

URL of retailer profile image

Minimum length: 1

Example:

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

results.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

results.retailer. is_rcn_retailer · boolean

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

Example:

false

results.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

results.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

results.retailer. requires_subscription · enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

results.retailer. brand_permit_creation_allowed · boolean

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

Example:

false

results.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

results.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

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

Example:

"demo-brand"

results.brand. id · integer

Vendor (brand) ID

Example:

500

results.brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

results.brand. joined_at · string

Time when vendor joined Dropship (UTC format)

Example:

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

results.brand. logo_url · string

URL of the brand logo

Minimum length: 1

Example:

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

results.brand. cover_url · string

URL of the cover image

Minimum length: 1

Example:

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

results.brand. profile_tile_url · string

URL of the profile image

Minimum length: 1

Example:

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

results.brand. website · string | null

URL of brand website

Maximum length: 100

Example:

null

results.brand. is_onboarded · boolean

true: Vendor is onboarded |false: Vendor is not onboarded

Example:

false

results.brand. is_on_rcn · boolean

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

Example:

false

results.brand. requires_subscription · enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

results.brand. subscription_expires_at · string | null

Subscription expiry Time (UTC format)

Example:

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

results.brand. grace_period_ends_at · string | null

Time of grace period expiration (UTC format)

Example:

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

results.brand. subscription_is_expired · boolean

true: subscription is expired | false: subscription is active

Example:

false

results.brand. subscription_is_on_grace_period · boolean

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

Example:

false

results.brand. subscription_is_delinquent · boolean

true: subscription is overdue | false: subscription is paid

Example:

false

results.brand. inventory_policy · enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

results.brand. status · enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

results. connection_id · string

Connection ID

Example:

2

results. currency · object

Show child attributes

results.currency. id · integer

Currency ID

Example:

1

results.currency. name · string

Currency name

Maximum length: 200

Example:

"United States Dollar"

results.currency. symbol · string | null

Currency symbol

Maximum length: 5

Example:

"$"

results.currency. unit · string

Currency unit

Example:

"USD"

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

results. terms_description · string | null

Description of invoice terms

Example:

"Previously agreed upon terms will apply"

results. terms_net_days_due · integer | null

Number of days to pay invoice

Required range: -2147483648 <= x <= 2147483647

Example:

35

results. terms_date_due · string | null

Payment expected date

Example:

null

results. terms_discount_percent · string | null

Discount percentage on selected term

Example:

null

results. order_id · integer

Order ID related to invoice

Example:

"O-654"

results. customer_order_number · string | null

Customer order number (for enduser)

Maximum length: 64

Example:

"CO-435"

results. purchase_order_number · string | null

Purchase order number (for retailer)

Maximum length: 64

Example:

"PO-546"

results. status · enum<string>

Invoice status

Available options:

closed,

open

Example:

"closed"

results. remit_to · object

Show child attributes

results.remit_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

results.remit_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

results.remit_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

results.remit_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

results.remit_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

results.remit_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

results.remit_to. id · integer

Address ID

Example:

10

results.remit_to. type · enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

results.remit_to. name2 · string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

results.remit_to. street2 · string | null

Line 2 of the address

Maximum length: 128

Example:

null

results.remit_to. phone1 · string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

results.remit_to. phone2 · string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

results.remit_to. fax · string | null

Fax number

Maximum length: 32

Example:

null

results.remit_to. email · string | null

Contact email address

Maximum length: 128

Example:

null

results.remit_to. federal_tax_id · string | null

Federal tax ID

Maximum length: 32

Example:

null

results. ship_from · object

Show child attributes

results.ship_from. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

results.ship_from. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

results.ship_from. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

results.ship_from. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

results.ship_from. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

results.ship_from. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

results.ship_from. id · integer

Address ID

Example:

10

results.ship_from. type · enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

results.ship_from. name2 · string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

results.ship_from. street2 · string | null

Line 2 of the address

Maximum length: 128

Example:

null

results.ship_from. phone1 · string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

results.ship_from. phone2 · string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

results.ship_from. fax · string | null

Fax number

Maximum length: 32

Example:

null

results.ship_from. email · string | null

Contact email address

Maximum length: 128

Example:

null

results.ship_from. federal_tax_id · string | null

Federal tax ID

Maximum length: 32

Example:

null

results. sold_to · object

Show child attributes

results.sold_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

results.sold_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

results.sold_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

results.sold_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

results.sold_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

results.sold_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

results.sold_to. id · integer

Address ID

Example:

10

results.sold_to. type · enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

results.sold_to. name2 · string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

results.sold_to. street2 · string | null

Line 2 of the address

Maximum length: 128

Example:

null

results.sold_to. phone1 · string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

results.sold_to. phone2 · string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

results.sold_to. fax · string | null

Fax number

Maximum length: 32

Example:

null

results.sold_to. email · string | null

Contact email address

Maximum length: 128

Example:

null

results.sold_to. federal_tax_id · string | null

Federal tax ID

Maximum length: 32

Example:

null

results. ship_to · object

Show child attributes

results.ship_to. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

results.ship_to. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

results.ship_to. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

results.ship_to. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

results.ship_to. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

results.ship_to. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

results.ship_to. id · integer

Address ID

Example:

10

results.ship_to. type · enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

results.ship_to. name2 · string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

results.ship_to. street2 · string | null

Line 2 of the address

Maximum length: 128

Example:

null

results.ship_to. phone1 · string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

results.ship_to. phone2 · string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

results.ship_to. fax · string | null

Fax number

Maximum length: 32

Example:

null

results.ship_to. email · string | null

Contact email address

Maximum length: 128

Example:

null

results.ship_to. federal_tax_id · string | null

Federal tax ID

Maximum length: 32

Example:

null

results. shipping_carrier_name · string | null

Name of shipping carrier

Maximum length: 32

Example:

"ALZ carrier"

results. shipping_carrier_code · string | null

Code of shipping carrier

Maximum length: 32

Example:

"230F"

results. shipping_account_number · string | null

Shipping account number

Maximum length: 32

Example:

"SH879"

results. shipping_method_name · string | null

Name of shipping method

Maximum length: 32

Example:

"Next day delivery"

results. shipping_method_code · string | null

Code of shipping method

Maximum length: 32

Example:

"ND"

results. shipping_tracking_number · string | null

Shipping tracking number

Maximum length: 32

Example:

"1Z9999999999999988"

results. shipping_weight · string | null

Shipping weight

Example:

"7.00"

results. notes · string | null

Additional info adding to shipping

Example:

"Signature required"

results. invoiced_at · string | null

Time when the invoice was created (UTC format).

Example:

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

results. ordered_at · string | null

Time of order finalization (UTC format)

Example:

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

results. shipped_at · string | null

Time of shipping (UTC format)

Example:

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

results. acknowledged_at · string | null

Time of retailer acknowledgement (UTC format)

Example:

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

results. paid_at · string | null

Time of payment (UTC format)

Example:

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

results. closed_at · string | null

Time of complete invoice payment (UTC format)

Example:

null

results. canceled_at · string | null

Time of order cancellation (UTC format)

Example:

null

results. allowances · object[]

Show child attributes

results.allowances. description · string · required

Description of allowance

Required string length: 1 - 128

Example:

"Sample-discount-allowance"

results.allowances. price · string · required

Allowance price

Example:

"12.10"

results.allowances. id · integer

Allowance ID

Example:

1

results.allowances. adjustment_code · object

Show child attributes

results.allowances.adjustment_code. adjustment_type · enum<string> · required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

results.allowances.adjustment_code. code · string · required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

results.allowances.adjustment_code. description · string · required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

results.allowances.adjustment_code. id · integer

Adjustment ID

Example:

1

results. charges · object[]

Show child attributes

results.charges. description · string · required

Invoice description

Required string length: 1 - 128

Example:

"Sample invoice and its description"

results.charges. price · string · required

Invoice price

Example:

"23.45"

results.charges. id · integer

Invoice ID

Example:

654

results.charges. adjustment_code · object

Show child attributes

results.charges.adjustment_code. adjustment_type · enum<string> · required

Adjustment type

Available options:

allowance,

charge

Example:

"Allowance"

results.charges.adjustment_code. code · string · required

Adjustment code

Required string length: 1 - 64

Example:

"returns_allowance"

results.charges.adjustment_code. description · string · required

Description of adjustment

Required string length: 1 - 128

Example:

"returns_allowance"

results.charges.adjustment_code. id · integer

Adjustment ID

Example:

1

results. invoice_lines · object[]

Show child attributes

results.invoice_lines. quantity · integer · required

Product quantity

Required range: -2147483648 <= x <= 2147483647

Example:

45

results.invoice_lines. price · string · required

Discounted price

Example:

"12.00"

results.invoice_lines. id · integer

Invoice line ID

Example:

765

results.invoice_lines. variant · object

Show child attributes

results.invoice_lines.variant. id · integer

Variant ID

Example:

100024

results.invoice_lines.variant. name · string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

results.invoice_lines.variant. brand · object

Show child attributes

results.invoice_lines.variant.brand. code · string · required

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

Required string length: 1 - 64

Example:

"demo-brand"

results.invoice_lines.variant.brand. id · integer

Vendor (brand) ID

Example:

500

results.invoice_lines.variant.brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

results.invoice_lines.variant.brand. joined_at · string

Time when vendor joined Dropship (UTC format)

Example:

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

results.invoice_lines.variant.brand. logo_url · string

URL of the brand logo

Minimum length: 1

Example:

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

results.invoice_lines.variant.brand. cover_url · string

URL of the cover image

Minimum length: 1

Example:

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

results.invoice_lines.variant.brand. profile_tile_url · string

URL of the profile image

Minimum length: 1

Example:

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

results.invoice_lines.variant.brand. website · string | null

URL of brand website

Maximum length: 100

Example:

null

results.invoice_lines.variant.brand. is_onboarded · boolean

true: Vendor is onboarded |false: Vendor is not onboarded

Example:

false

results.invoice_lines.variant.brand. is_on_rcn · boolean

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

Example:

false

results.invoice_lines.variant.brand. requires_subscription · enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

results.invoice_lines.variant.brand. subscription_expires_at · string | null

Subscription expiry Time (UTC format)

Example:

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

results.invoice_lines.variant.brand. grace_period_ends_at · string | null

Time of grace period expiration (UTC format)

Example:

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

results.invoice_lines.variant.brand. subscription_is_expired · boolean

true: subscription is expired | false: subscription is active

Example:

false

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

results.invoice_lines.variant.brand. subscription_is_delinquent · boolean

true: subscription is overdue | false: subscription is paid

Example:

false

results.invoice_lines.variant.brand. inventory_policy · enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

results.invoice_lines.variant.brand. status · enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

results.invoice_lines.variant. brand_identifier · string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

results.invoice_lines.variant. identifier · string | null

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

Maximum length: 128

Example:

"5000001"

results.invoice_lines.variant. upc · string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

results.invoice_lines.variant. cartons · object[]

Show child attributes

results.invoice_lines.variant.cartons. id · integer

Carton ID

Example:

48

results.invoice_lines.variant.cartons. number · integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

results.invoice_lines.variant.cartons. length · string | null

Carton length

Example:

"1"

results.invoice_lines.variant.cartons. length_unit · string

Unit of length

Example:

"1"

results.invoice_lines.variant.cartons. width · string | null

Carton width

Example:

"1"

results.invoice_lines.variant.cartons. width_unit · string

Unit of width

Example:

"meter"

results.invoice_lines.variant.cartons. height · string | null

Carton height

Example:

"1"

results.invoice_lines.variant.cartons. height_unit · string

Unit of height

Example:

"meter"

results.invoice_lines.variant.cartons. weight · string | null

Carton weight

Example:

"15"

results.invoice_lines.variant.cartons. weight_unit · string

Unit of weight

Example:

"KG"

results.invoice_lines.variant.cartons. package_girth_inches · string

Girth of the package, in inches

Example:

"1"

results.invoice_lines.variant.cartons. package_size_inches · string

Size of the package, in inches

Example:

"1"

results.invoice_lines.variant. color · string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

results.invoice_lines.variant. style · string | null

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

Maximum length: 128

Example:

"Print"

results.invoice_lines.variant. size · string | null

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

Maximum length: 128

Example:

"Large"

results.invoice_lines.variant. media · object[]

Show child attributes

results.invoice_lines.variant.media. id · integer

Variant ID

Example:

249

results.invoice_lines.variant.media. width · integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

results.invoice_lines.variant.media. height · integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

results.invoice_lines.variant.media. media · string

Variant images

Example:

"default"

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

results.invoice_lines.variant.media. url · string

URL of variant image

Example:

"https://cdn.example.com/media/default/original"

results.invoice_lines.variant.media. updated_at · string

Time of variant image update (UTC format)

Example:

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

results.invoice_lines.variant.media. created_at · string

Time of variant image creation (UTC format)

Example:

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

results.invoice_lines.variant. attributes · object[]

Show child attributes

results.invoice_lines.variant.attributes. code · string · required

Attribute code

Required string length: 1 - 200

Example:

"size"

results.invoice_lines.variant.attributes. name · string · required

Attribute name

Required string length: 1 - 200

Example:

"Size"

results.invoice_lines.variant.attributes. type · enum<string> · required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

results.invoice_lines.variant.attributes. id · integer

Attribute ID

Example:

44

results.invoice_lines.variant.attributes. editable_by · enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

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

results.invoice_lines.variant.attributes. description · string | null

Attribute description

Example:

"demo product description"

results.invoice_lines.variant.attributes. units · string | null

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

Maximum length: 32

Example:

"USD"

results.invoice_lines.variant.attributes. values · object

Show child attributes

results.invoice_lines.variant. ruleset_variants · object[]

Show child attributes

results.invoice_lines.variant.ruleset_variants. id · integer

ID of ruleset variant

Example:

1232

results.invoice_lines.variant.ruleset_variants. status · enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

results.invoice_lines.variant.ruleset_variants. results · string

Response

results.invoice_lines.variant.ruleset_variants. created_at · string

Time of creation (UTC format)

Example:

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

results.invoice_lines.variant.ruleset_variants. updated_at · string

Time of last update (UTC format)

Example:

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

results.invoice_lines.variant. ruleset_variant_summary · string

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

Example:

"21"

results.invoice_lines.variant. active_permit · object

Show child attributes

results.invoice_lines.variant.active_permit. id · integer

Permit ID

Example:

10104

results.invoice_lines.variant.active_permit. retailer · object

Show child attributes

results.invoice_lines.variant.active_permit. retailer_price · string | null

Retailer price of the variant

Example:

"12.99"

results.invoice_lines.variant.active_permit. retailer_cost · string | null

Retailer cost of variant

Example:

"8.99"

results.invoice_lines.variant.active_permit. pricing · object

results.invoice_lines.variant.active_permit. attributes · object

results.invoice_lines.variant.active_permit. start_at · string | null

Time of permit start (UTC format)

Example:

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

results.invoice_lines.variant.active_permit. end_at · string | null

Time of permit end (UTC format)

Example:

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

results.invoice_lines.variant.active_permit. is_in_effect · boolean

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

Example:

true

results.invoice_lines.variant.active_permit. revoked_at · string | null

Time when permit got revoked (UTC format)

Example:

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

results.invoice_lines.variant.active_permit. is_acknowledged · boolean

true: permit is acknowledged | false: permit is not acknowledged

Example:

true

results.invoice_lines.variant.active_permit. acknowledged_at · string | null

Time of acknowledgement (UTC format)

Example:

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

results.invoice_lines.variant. permits · object[]

Show child attributes

results.invoice_lines.variant.permits. id · integer

Permit ID

Example:

10104

results.invoice_lines.variant.permits. retailer · object

Show child attributes

results.invoice_lines.variant.permits. retailer_price · string | null

Retailer price of the variant

Example:

"12.99"

results.invoice_lines.variant.permits. retailer_cost · string | null

Retailer cost of variant

Example:

"8.99"

results.invoice_lines.variant.permits. pricing · object

results.invoice_lines.variant.permits. attributes · object

results.invoice_lines.variant.permits. start_at · string | null

Time of permit start (UTC format)

Example:

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

results.invoice_lines.variant.permits. end_at · string | null

Time of permit end (UTC format)

Example:

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

results.invoice_lines.variant.permits. is_in_effect · boolean

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

Example:

true

results.invoice_lines.variant.permits. revoked_at · string | null

Time when permit got revoked (UTC format)

Example:

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

results.invoice_lines.variant.permits. is_acknowledged · boolean

true: permit is acknowledged | false: permit is not acknowledged

Example:

true

results.invoice_lines.variant.permits. acknowledged_at · string | null

Time of acknowledgement (UTC format)

Example:

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

results.invoice_lines.variant. is_compatible · boolean

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

Example:

true

results.invoice_lines.variant. proposal_variant · object

Show child attributes

results.invoice_lines.variant.proposal_variant. id · integer

Proposal variant ID

Example:

3456

results.invoice_lines.variant.proposal_variant. pricing · string

Pricing of variant

Example:

"12.00"

results.invoice_lines.variant.proposal_variant. attributes · object[]

Show child attributes

results.invoice_lines.variant.proposal_variant. memos · object[]

Show child attributes

results.invoice_lines.variant.proposal_variant. issues · object[]

Show child attributes

results.invoice_lines.variant.proposal_variant. variant_id · integer

Variant ID

Example:

249

results.invoice_lines.variant.proposal_variant. approved_at · string | null

Time of approval (UTC format)

Example:

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

results.invoice_lines.variant.proposal_variant. created_at · string

Time of creation (UTC format)

Example:

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

results.invoice_lines.variant.proposal_variant. updated_at · string

Time of last update (UTC format)

Example:

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

results.invoice_lines.variant.proposal_variant. rejected_at · string | null

Time of proposal rejection (UTC format)

Example:

null

results.invoice_lines.variant.proposal_variant. reject_reason · string | null

Rejection reason

Maximum length: 32

Example:

"Incomplete"

results.invoice_lines.variant.proposal_variant. reject · boolean

true: proposal is rejected | false: proposal is not rejected

Example:

true

results.invoice_lines.variant.proposal_variant. approve · boolean

true: proposal is approved | false: proposal is not approved

Example:

false

results.invoice_lines.variant.proposal_variant. delete · boolean

true: proposal is deleted | false: proposal is not deleted

Example:

false

results.invoice_lines.variant. retailer_identifiers · object

Show child attributes

results.invoice_lines.variant.retailer_identifiers. id · integer

Retailer ID

Example:

5642

results.invoice_lines.variant.retailer_identifiers. retailer · object

Show child attributes

results.invoice_lines.variant.retailer_identifiers. identifier · string | null

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

Maximum length: 256

Example:

"SKU976"

results.invoice_lines.variant.retailer_identifiers. name · string | null

Retailer name

Maximum length: 256

Example:

"Retailer Sample"

results.invoice_lines.variant. retailer_categories · object

Show child attributes

results.invoice_lines.variant.retailer_categories. category · string · required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

results.invoice_lines.variant.retailer_categories. id · integer

Retailer category ID

Example:

453

results.invoice_lines.variant.retailer_categories. retailer · object

Show child attributes

results.invoice_lines.variant. inventory · object

Show child attributes

results.invoice_lines.variant.inventory. inventory_updated_at · string · required

Time of inventory update (UTC format)

Example:

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

results.invoice_lines.variant.inventory. inventory_last_submitted_at · string · required

Time of inventory submit (UTC format)

Example:

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

results.invoice_lines.variant.inventory. brand_inventory_updated_at · string · required

Time of vendor inventory update (UTC format)

Example:

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

results.invoice_lines.variant.inventory. sellable_updated_at · string · required

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

Example:

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

results.invoice_lines.variant.inventory. estimated_availability_date · string · required

Estimated delivery date (UTC format)

Minimum length: 1

Example:

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

results.invoice_lines.variant.inventory. discontinued · boolean

true: Product is discontinued | false: Product is active

Example:

true

results.invoice_lines.variant.inventory. discontinued_updated_at · string

Time of when product inventory was discontinued (UTC format)

Example:

null

results.invoice_lines.variant.inventory. inventory · integer

Inventory of variant

Example:

0

results.invoice_lines.variant.inventory. sellable · string

yes: Variant is sellable | No: Variant is not sellable

Example:

"No"

results.invoice_lines.variant.inventory. replenishable · boolean

true: product is replenishable | false: product is not replenishable

Example:

true

results.invoice_lines.variant.inventory. locations · object[]

Show child attributes

results.invoice_lines. invoice_line_number · integer | null

Invoice line number

Required range: -2147483648 <= x <= 2147483647

Example:

2

results.invoice_lines. item_brand_identifier · string | null

Vendor identifier of product

Maximum length: 128

Example:

"Vend134"

results.invoice_lines. item_upc · string | null

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in the marketplace system

Maximum length: 32

Example:

"911911911112"

results.invoice_lines. name · string | null

Product name

Maximum length: 128

Example:

"SamPro1"

results.invoice_lines. description · string | null

Product description

Maximum length: 128

Example:

"Sample description of product"

results.invoice_lines. canceled_at · string | null

Time of cancellation (UTC format)

Example:

null

results.invoice_lines. retail_price · string

Retail price

Example:

"14.00"

results. net_amount · string | null

Total invoice amount (excluding taxes)

Example:

"12.89"

results. due_amount · string | null

Pending amount

Example:

"2.89"

results. expected_due_amount · string | null

Expected due amount (excluding allowances and charges)

Example:

"2.89"

results. subtotal · string | null

Sub-total

Example:

"10.89"

results. tax · string | null

Total tax on the invoice

Example:

"2.00"

results. invoice_acceptance · object

Show child attributes

results.invoice_acceptance. id · integer

Invoice acceptance ID

Example:

565

results.invoice_acceptance. accepted_by · object

Vendor acceptance

Show child attributes

results.invoice_acceptance.accepted_by. id · integer

User ID who accepted or rejected the invoice

Example:

542

results.invoice_acceptance.accepted_by. first_name · string | null

First name of user

Maximum length: 64

Example:

"Sample"

results.invoice_acceptance.accepted_by. last_name · string | null

Last name of user

Maximum length: 64

Example:

"Demo"

results.invoice_acceptance.accepted_by. title · string | null

User title

Maximum length: 64

Example:

"Demo"

results.invoice_acceptance.accepted_by. status · enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

results.invoice_acceptance.accepted_by. type · enum<string>

User type

Available options:

standard,

api

Example:

"standard"

results.invoice_acceptance.accepted_by. photo_url · string

URL of the user photo

Minimum length: 1

Example:

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

results.invoice_acceptance.accepted_by. profile_photo · string

URL of the user's profile photo

Minimum length: 1

Example:

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

results.invoice_acceptance.accepted_by. is_me · boolean

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

Example:

true

results.invoice_acceptance. rejected_by · object

Show child attributes

results.invoice_acceptance.rejected_by. id · integer

User ID who accepted or rejected the invoice

Example:

542

results.invoice_acceptance.rejected_by. first_name · string | null

First name of user

Maximum length: 64

Example:

"Sample"

results.invoice_acceptance.rejected_by. last_name · string | null

Last name of user

Maximum length: 64

Example:

"Demo"

results.invoice_acceptance.rejected_by. title · string | null

User title

Maximum length: 64

Example:

"Demo"

results.invoice_acceptance.rejected_by. status · enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

results.invoice_acceptance.rejected_by. type · enum<string>

User type

Available options:

standard,

api

Example:

"standard"

results.invoice_acceptance.rejected_by. photo_url · string

URL of the user photo

Minimum length: 1

Example:

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

results.invoice_acceptance.rejected_by. profile_photo · string

URL of the user's profile photo

Minimum length: 1

Example:

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

results.invoice_acceptance.rejected_by. is_me · boolean

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

Example:

true

results.invoice_acceptance. reject_reason · string | null

Reason for invoice rejection

Maximum length: 128

Example:

"Incorrect"

results.invoice_acceptance. accepted_at · string | null

Time when the invoice was accepted (UTC format).

Example:

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

results.invoice_acceptance. rejected_at · string | null

Time when the invoice was accepted (UTC format).

Example:

null

next · string | null

Next page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=5"

previous · string | null

Previous page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=3"