Acknowledge receipt of a new permit

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

PUT

retailers

{retailer_pk}

permits

{id}

acknowledge

object

retailer

object

name

string

code

string

is_rcn_retailer

boolean

is_onboarded

boolean

platform

enum<string>

requires_subscription

enum<string>

brand_permit_creation_allowed

boolean

website

string

status

enum<string>

variant

object

name

string

brand

object

code

string

name

string

identifier

string

upc

string

retailer_identifiers

array

connection

object

connection_fee

object

payment_model

enum<string>

payment_terms

enum<string>

net_price_method

enum<string>

revshare_fraction

string

revc_fee_flat

string

revc_fee_fraction

string

brand_fee_flat

string

brand_flat_order_fee

string

brand_percent_order_fee

string

retailer_price

string

retailer_cost

string

pricing

object

attributes

object

start_at

string

end_at

string

revoked_at

string

acknowledged_at

string

Authorizations

Authorization

string

headerrequired

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

Path Parameters

integer

required

Permit ID

retailer_pk

number

required

Retailer ID

Body

application/json

retailer

object

variant

object

connection

object

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

revoked_at

string | null

Time of when permit got revoked

acknowledged_at

string | null

Time of permit acknowledgement (UTC format)

Response

200 - application/json

integer

Permit ID

retailer

object

variant

object

connection

object

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)

Was this page helpful?

Get variants Get single product details