Acknowledge receipt of a new permit

Retailers, generally, include is_acknowledged=0 as a query parameter to get only new permits. Then, for each permit returned, retailers should process the permit and update any necessary internal systems, such as Product Catalog. After processing a permit successfully, they should acknowledge the permit using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint does not return the processed shipment.

Authorizations

Authorization

string

headerrequired

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

Body

application/json

retailer

object

Show child attributes

variant

object

Show child attributes

connection

object

Show child attributes

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

id

integer

Permit ID

retailer

object

Show child attributes

variant

object

Show child attributes

connection

object

Show child attributes

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)