Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
mutation PublishOption($id: ID!, $input: PublishOptionInput!) {
publishOption(id: $id, input: $input) {
id
object
name
status
livemode
created
updated
key
standardized
carrier_code
description
conflicts_with
requires
surcharge
version
}
}
{
"id": "opt_1a2B3c",
"input": {
"effective_from": "2026-10-07"
}
}
{
"data": {
"publishOption": {
"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
}
}
}
Publish a option
mutation PublishOption($id: ID!, $input: PublishOptionInput!) {
publishOption(id: $id, input: $input) {
id
object
name
status
livemode
created
updated
key
standardized
carrier_code
description
conflicts_with
requires
surcharge
version
}
}
{
"id": "opt_1a2B3c",
"input": {
"effective_from": "2026-10-07"
}
}
{
"data": {
"publishOption": {
"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
}
}
}
mutation · Module: Catalog · Requires catalog:write
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
input | PublishOptionInput | The fields for this operation. |
PublishOptionInput fields| Field | Type |
|---|---|
effective_from | String |
CatalogOption!
| Field | Type |
|---|---|
id | String! |
object | CatalogOptionObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
key | String! |
standardized | Boolean |
carrier_code | String |
name | String |
description | String |
schema | JsonSchema! |
conflicts_with | [String!] |
requires | [String!] |
surcharge | String |
status | CatalogOptionStatus! |
version | Int |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation PublishOption($id: ID!, $input: PublishOptionInput!) {
publishOption(id: $id, input: $input) {
id
object
name
status
livemode
created
updated
key
standardized
carrier_code
description
conflicts_with
requires
surcharge
version
}
}
{
"id": "opt_1a2B3c",
"input": {
"effective_from": "2026-10-07"
}
}
{
"data": {
"publishOption": {
"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
}
}
}