Get active permits

Gets active permits by retailer ad permit IDs.

Authorizations

Authorization

string

header

required

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

Path Parameters

id

integer

required

Permit ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

OK

id

integer

Permit ID

retailer

object

Show child attributes

retailer.name

string

required

Retailer name

Required string length: 1 - 64

retailer.code

string

required

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

Required string length: 1 - 32

retailer.id

integer

Retailer ID

retailer.logo_url

string

URL of retailer logo

Minimum length: 1

retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

retailer.is_rcn_retailer

boolean

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

retailer.is_onboarded

boolean

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

retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

retailer.brand_permit_creation_allowed

boolean

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

retailer.website

string | null

Website URL

Maximum length: 100

retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant

object

Show child attributes

variant.id

integer

Variant ID

variant.name

string | null

Variant name

Maximum length: 200

variant.brand

object

Show child attributes

variant.brand.code

string

required

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

Required string length: 1 - 64

variant.brand.id

integer

Vendor ID

variant.brand.name

string

Vendor name

Required string length: 1 - 64

variant.identifier

string | null

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

Maximum length: 128

variant.brand_identifier

string

Brand identifier

Minimum length: 1

variant.upc

string

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

Maximum length: 64

variant.retailer_identifiers

object[]

Show child attributes

variant.retailer_identifiers.id

integer

Retailer ID

variant.retailer_identifiers.retailer

object

Show child attributes

variant.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variant.retailer_identifiers.retailer.code

string

required

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

Required string length: 1 - 32

variant.retailer_identifiers.retailer.id

integer

Retailer ID

variant.retailer_identifiers.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variant.retailer_identifiers.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variant.retailer_identifiers.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variant.retailer_identifiers.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variant.retailer_identifiers.retailer.is_rcn_retailer

boolean

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

variant.retailer_identifiers.retailer.is_onboarded

boolean

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

variant.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variant.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variant.retailer_identifiers.retailer.brand_permit_creation_allowed

boolean

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

variant.retailer_identifiers.retailer.website

string | null

Website URL

Maximum length: 100

variant.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

connection

object

Show child attributes

connection.id

integer

Connection permit ID

connection.connection_fee

object

Show child attributes

connection.connection_fee.id

integer

Connection fee ID

connection.connection_fee.payment_model

enum<string> | null

Payment model

Available options:

direct,

managed

connection.connection_fee.payment_terms

enum<string> | null

Payment terms

Available options:

net15,

net30,

net45,

net60,

net90

connection.connection_fee.net_price_method

enum<string> | null

Method used to calculate net price

Available options:

estimated_commission,

product_cost,

specified_in_order,

revshare,

permit_cost

connection.connection_fee.revshare_fraction

string | null

Internal only

connection.connection_fee.revc_fee_flat

string

Internal only

Minimum length: 1

connection.connection_fee.revc_fee_fraction

string

Internal only

Minimum length: 1

connection.connection_fee.brand_fee_flat

string

Internal only

Minimum length: 1

connection.connection_fee.brand_flat_order_fee

string | null

Internal only

connection.connection_fee.brand_percent_order_fee

string | null

Vendor percentage of order fee

connection.connection_fee.effective_at

string

Time connection fee became effective (UTC format)

retailer_price

string | null

Retailer price

retailer_cost

string | null

Retailer cost

pricing

object

attributes

object

start_at

string | null

Time of permit beginning

end_at

string | null

Time of permit ending

is_in_effect

boolean

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

revoked_at

string | null

Time of when permit got revoked

is_acknowledged

boolean

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

acknowledged_at

string | null

Time of permit acknowledgement (UTC format)