query · Module: Catalog
Arguments
Returns
CatalogOptionList!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query OptionVersions($id: ID!) {
optionVersions(id: $id) {
data {
id
object
name
status
livemode
created
updated
key
standardized
carrier_code
description
conflicts_with
requires
surcharge
version
}
has_more
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"optionVersions": {
"data": [
{
"id": "opt_1a2B3c",
"object": "option",
"name": "Example",
"status": "draft",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"key": "signature",
"standardized": true,
"carrier_code": "EXPRESS_WORLDWIDE",
"description": "Example description",
"conflicts_with": [
"example"
],
"requires": [
"example"
],
"surcharge": "example",
"version": 3
}
],
"has_more": true
}
}
}
List option versions
query OptionVersions($id: ID!) {
optionVersions(id: $id) {
data {
id
object
name
status
livemode
created
updated
key
standardized
carrier_code
description
conflicts_with
requires
surcharge
version
}
has_more
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"optionVersions": {
"data": [
{
"id": "opt_1a2B3c",
"object": "option",
"name": "Example",
"status": "draft",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"key": "signature",
"standardized": true,
"carrier_code": "EXPRESS_WORLDWIDE",
"description": "Example description",
"conflicts_with": [
"example"
],
"requires": [
"example"
],
"surcharge": "example",
"version": 3
}
],
"has_more": true
}
}
}
query · Module: Catalog
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
CatalogOptionList!
| Field | Type |
|---|---|
data | [CatalogOption!]! |
has_more | Boolean |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query OptionVersions($id: ID!) {
optionVersions(id: $id) {
data {
id
object
name
status
livemode
created
updated
key
standardized
carrier_code
description
conflicts_with
requires
surcharge
version
}
has_more
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"optionVersions": {
"data": [
{
"id": "opt_1a2B3c",
"object": "option",
"name": "Example",
"status": "draft",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"key": "signature",
"standardized": true,
"carrier_code": "EXPRESS_WORLDWIDE",
"description": "Example description",
"conflicts_with": [
"example"
],
"requires": [
"example"
],
"surcharge": "example",
"version": 3
}
],
"has_more": true
}
}
}