Get a permit

curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/permits/{id}/ \
  --header 'Authorization: Bearer <token>'

{
  "id": 10004,
  "retailer": {
    "name": "Demo Retailer",
    "code": "demo-retailer",
    "id": 500,
    "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
    "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
    "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
    "joined_at": "2021-08-03T17:24:12Z",
    "is_rcn_retailer": false,
    "is_onboarded": false,
    "platform": "fabric",
    "requires_subscription": "disabled",
    "brand_permit_creation_allowed": false,
    "website": "https://demoabc.com",
    "status": "active"
  },
  "variant": {
    "id": 249,
    "name": "Var45",
    "brand": {
      "code": "marla-store",
      "id": 456,
      "name": "Marla Store"
    },
    "identifier": "123-DEF12345",
    "brand_identifier": "HATR",
    "upc": 555555555202,
    "retailer_identifiers": [
      {
        "id": 5642,
        "retailer": {
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "id": 500,
          "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
          "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
          "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
          "joined_at": "2021-08-03T17:24:12Z",
          "is_rcn_retailer": false,
          "is_onboarded": false,
          "platform": "fabric",
          "requires_subscription": "disabled",
          "brand_permit_creation_allowed": false,
          "website": "https://demoabc.com",
          "status": "active"
        },
        "identifier": "SKU976",
        "name": "Retailer Sample"
      }
    ]
  },
  "connection": {
    "id": 1000,
    "connection_fee": {
      "id": 1000,
      "payment_model": "managed",
      "payment_terms": "net60",
      "net_price_method": "permit_cost",
      "revshare_fraction": "0.4000",
      "revc_fee_flat": "0.00",
      "revc_fee_fraction": "0.0300",
      "brand_fee_flat": "0.00",
      "brand_flat_order_fee": "0.00",
      "brand_percent_order_fee": "0.0000",
      "effective_at": "2015-10-10T00:00:00Z"
    }
  },
  "retailer_price": "12.99",
  "retailer_cost": "8.99",
  "pricing": {},
  "attributes": {},
  "start_at": "2021-07-10T15:24:56Z",
  "end_at": "2022-11-10T15:24:56Z",
  "is_in_effect": true,
  "revoked_at": "2022-08-10T15:24:56Z",
  "is_acknowledged": true,
  "acknowledged_at": "2022-08-10T15:24:56Z"
}

GET

retailers

{retailer_id}

permits

{id}

Get a permit

curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/permits/{id}/ \
  --header 'Authorization: Bearer <token>'

{
  "id": 10004,
  "retailer": {
    "name": "Demo Retailer",
    "code": "demo-retailer",
    "id": 500,
    "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
    "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
    "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
    "joined_at": "2021-08-03T17:24:12Z",
    "is_rcn_retailer": false,
    "is_onboarded": false,
    "platform": "fabric",
    "requires_subscription": "disabled",
    "brand_permit_creation_allowed": false,
    "website": "https://demoabc.com",
    "status": "active"
  },
  "variant": {
    "id": 249,
    "name": "Var45",
    "brand": {
      "code": "marla-store",
      "id": 456,
      "name": "Marla Store"
    },
    "identifier": "123-DEF12345",
    "brand_identifier": "HATR",
    "upc": 555555555202,
    "retailer_identifiers": [
      {
        "id": 5642,
        "retailer": {
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "id": 500,
          "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
          "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
          "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
          "joined_at": "2021-08-03T17:24:12Z",
          "is_rcn_retailer": false,
          "is_onboarded": false,
          "platform": "fabric",
          "requires_subscription": "disabled",
          "brand_permit_creation_allowed": false,
          "website": "https://demoabc.com",
          "status": "active"
        },
        "identifier": "SKU976",
        "name": "Retailer Sample"
      }
    ]
  },
  "connection": {
    "id": 1000,
    "connection_fee": {
      "id": 1000,
      "payment_model": "managed",
      "payment_terms": "net60",
      "net_price_method": "permit_cost",
      "revshare_fraction": "0.4000",
      "revc_fee_flat": "0.00",
      "revc_fee_fraction": "0.0300",
      "brand_fee_flat": "0.00",
      "brand_flat_order_fee": "0.00",
      "brand_percent_order_fee": "0.0000",
      "effective_at": "2015-10-10T00:00:00Z"
    }
  },
  "retailer_price": "12.99",
  "retailer_cost": "8.99",
  "pricing": {},
  "attributes": {},
  "start_at": "2021-07-10T15:24:56Z",
  "end_at": "2022-11-10T15:24:56Z",
  "is_in_effect": true,
  "revoked_at": "2022-08-10T15:24:56Z",
  "is_acknowledged": true,
  "acknowledged_at": "2022-08-10T15:24:56Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

retailer_id

integer

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.

Example:

1001

integer

required

The unique permit identifier. This ID is automatically generated when a permit is created.

Response

200 - application/json

integer

Permit ID

Example:

10004

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>

Represents whether the retailer requires a 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"

variant

object

Show child attributes

variant.id

integer

Variant ID

Example:

249

variant.name

string | null

Variant name

Maximum string length: 200

Example:

"Var45"

variant.brand

object

Show child attributes

variant.brand.code

string<slug>

required

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

Required string length: 1 - 64

Example:

"marla-store"

variant.brand.id

integer

Vendor ID

Example:

456

variant.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Store"

variant.identifier

string | null

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

Maximum string length: 128

Example:

"123-DEF12345"

variant.brand_identifier

string

Brand identifier

Minimum string length: 1

Example:

"HATR"

variant.upc

string

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

Maximum string length: 64

Example:

555555555202

variant.retailer_identifiers

object[]

Show child attributes

variant.retailer_identifiers.id

integer

Retailer ID

Example:

5642

variant.retailer_identifiers.retailer

object

Show child attributes

variant.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

variant.retailer_identifiers.retailer.id

integer

Retailer ID

Example:

500

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"

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"

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"

variant.retailer_identifiers.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

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

variant.retailer_identifiers.retailer.is_rcn_retailer

boolean

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

Example:

false

variant.retailer_identifiers.retailer.is_onboarded

boolean

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

Example:

false

variant.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variant.retailer_identifiers.retailer.requires_subscription

enum<string>

Represents whether the retailer requires a subscription to use the platform.

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

variant.retailer_identifiers.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

variant.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variant.retailer_identifiers.identifier

string | null

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

Maximum string length: 256

Example:

"SKU976"

variant.retailer_identifiers.name

string | null

Retailer name

Maximum string length: 256

Example:

"Retailer Sample"

connection

object

Show child attributes

connection.id

integer

Connection permit ID

Example:

1000

connection.connection_fee

object

Show child attributes

connection.connection_fee.id

integer

Connection fee ID

Example:

1000

connection.connection_fee.payment_model

enum<string> | null

Payment model

Available options:

direct,

managed

Example:

"managed"

connection.connection_fee.payment_terms

enum<string> | null

Payment terms

Available options:

net15,

net30,

net45,

net60,

net90

Example:

"net60"

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

Example:

"permit_cost"

connection.connection_fee.revshare_fraction

string<decimal> | null

Internal only

Example:

"0.4000"

connection.connection_fee.revc_fee_flat

string

Internal only

Minimum string length: 1

Example:

"0.00"

connection.connection_fee.revc_fee_fraction

string

Internal only

Minimum string length: 1

Example:

"0.0300"

connection.connection_fee.brand_fee_flat

string

Internal only

Minimum string length: 1

Example:

"0.00"

connection.connection_fee.brand_flat_order_fee

string<decimal> | null

Internal only

Example:

"0.00"

connection.connection_fee.brand_percent_order_fee

string<decimal> | null

Vendor percentage of order fee

Example:

"0.0000"

connection.connection_fee.effective_at

string<date-time>

Time connection fee became effective (UTC format)

Example:

"2015-10-10T00:00:00Z"

retailer_price

string<decimal> | null

Retailer price

Example:

"12.99"

retailer_cost

string<decimal> | null

Retailer cost

Example:

"8.99"

pricing

object

attributes

object

start_at

string<date-time> | null

Time of permit beginning

Example:

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

end_at

string<date-time> | null

Time of permit ending

Example:

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

is_in_effect

boolean

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

Example:

true

revoked_at

string<date-time> | null

Time of when permit got revoked

Example:

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

is_acknowledged

boolean

true: Permit is acknowledged | false: Permit is not acknowledged

Example:

true

acknowledged_at

string<date-time> | null

Time of permit acknowledgement (UTC format)

Example:

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

Update variant attributes Acknowledge a permit receipt

⌘I

Dropship

Merchants

Merchant API Endpoints

Suppliers

Supplier API Endpoints

Get a permit

Authorizations

Path Parameters

Response