Update Shipping Term

Beta
PATCH/v1/operations/shipping-terms/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an account-owned shipping term. Default shipping terms cannot be updated.

idstring

Shipping term ID.

include[]optional arrayenumValues:ownerowner.accountflat_rate.unit

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

Display name.

typeoptional stringenumValues:free_freightflat_rate_freightcarrier_rate_freight

Shipping term type.

flat_rateoptional objectnullable

Flat rate. Send null to clear.

valuestring (decimal)

The decimal value.

unit_idstring

The unit ID for the value.

minimum_order_valueoptional objectnullable

Minimum order value for free shipping. Send null to clear.

valuestring (decimal)

The decimal value.

unit_idstring

The unit ID for the value.

free_shipping_service_level_idsoptional array of stringnullable

Service level IDs that qualify for free shipping. Send null to clear.

idstring

Shipping term ID.

objectstringenumValues:shipping_term

Resource type identifier.

namestring

Display name.

typestringenumValues:free_freightflat_rate_freightcarrier_rate_freight

Shipping term type.

ownerobjectExpandablenullable

Owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.
default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.
brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.
portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

flat_rateobjectnullable

Flat rate quantity, if any.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitobjectExpandablenullable

Associated unit.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Unit dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions. Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator. Typically 1.

is_base_unitboolean

Whether this is the base unit for its dimension. Conversion ratios are relative to this unit.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.
created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

minimum_order_valueobjectnullable

Minimum order value quantity, if any.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitobjectExpandablenullable

Associated unit.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Unit dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions. Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator. Typically 1.

is_base_unitboolean

Whether this is the base unit for its dimension. Conversion ratios are relative to this unit.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.
created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

free_shipping_service_levelsobjectExpandablenullable

Service levels that qualify for free shipping.

objectstringenumValues:list

Object type for ServiceLevel list

page_infoobject

Pagination metadata for ServiceLevel list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of ServiceLevel resources in this page

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Display name.

service_level_tokenstring

Service level token.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

is_defaultboolean

Default service level for the carrier.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

Responses

200

Successful response for Update Shipping Term