PUT
/
v1
/
retailers
/
{retailer_id}
/
permits
/
{id}
/
acknowledge
/
Acknowledge a permit receipt
curl --request PUT \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/permits/{id}/acknowledge/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "retailer": {
    "name": "Demo Retailer",
    "code": "demo-retailer",
    "is_rcn_retailer": false,
    "is_onboarded": false,
    "platform": "fabric",
    "requires_subscription": "disabled",
    "brand_permit_creation_allowed": false,
    "website": "https://demoabc.com",
    "status": "active"
  },
  "variant": {
    "name": "Var45",
    "brand": {
      "code": "marla-store",
      "name": "Marla Store"
    },
    "identifier": "123-DEF12345",
    "upc": 555555555202,
    "retailer_identifiers": [
      {
        "retailer": {
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "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": {
    "connection_fee": {
      "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"
    }
  },
  "retailer_price": "12.99",
  "retailer_cost": "8.99",
  "pricing": {},
  "attributes": {},
  "start_at": "2021-07-10T15:24:56Z",
  "end_at": "2022-11-10T15:24:56Z",
  "revoked_at": "2022-08-10T15:24:56Z",
  "acknowledged_at": "2022-08-10T15:24:56Z"
}'
{
  "id": 10004,
  "retailer": {
    "id": 500,
    "name": "Demo Retailer",
    "code": "demo-retailer",
    "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": {
      "id": 456,
      "code": "marla-store",
      "name": "Marla Store"
    },
    "identifier": "123-DEF12345",
    "brand_identifier": "HATR",
    "upc": 555555555202,
    "retailer_identifiers": [
      {
        "id": 5642,
        "retailer": {
          "id": 500,
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "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

​
id
integer
required

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

Body

application/json
​
retailer
object
​
variant
object
​
connection
object
​
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"

​
revoked_at
string<date-time> | null

Time of when permit got revoked

Example:

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

​
acknowledged_at
string<date-time> | null

Time of permit acknowledgement (UTC format)

Example:

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

Response

200 - application/json

Ok

​
id
integer

Permit ID

Example:

10004

​
retailer
object
​
variant
object
​
connection
object
​
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"