Skip to main content
Skip to main content

PublishableApiKey

A Publishable API key defines scopes that resources are available in. Then, it can be used in request to infer the resources without having to directly pass them. For example, a publishable API key can be associated with one or more sales channels. Then, when the publishable API key is passed in the header of a request, it is inferred what sales channel is being used without having to pass the sales channel as a query or body parameter of the request. Publishable API keys can only be used with sales channels, at the moment.

Properties

created_atDateRequired
The date with timezone at which the resource was created.
created_bynull | stringRequired
The unique identifier of the user that created the key.
idstringRequired
The key's ID
revoked_atDate
The date with timezone at which the key was revoked.
revoked_bynull | stringRequired
The unique identifier of the user that revoked the key.
titlestringRequired
The key's title.
updated_atDateRequired
The date with timezone at which the resource was updated.
Was this section helpful?