Shipping method updated

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

ShippingMethodSchema · object

required

Show child attributes

data.id

string

The unique ID of the shipping method.

Example:

"shipping_method_id"

data.created_date

string<date-time>

The date the shipping method was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the shipping method was last updated.

Example:

"2022-01-02T05:05:05Z"

data.name

string

The name of the shipping method.

Example:

"Priority Overnight"

data.carrier

string | null

The carrier of the shipping method. Deprecated, use carrier_id instead.

Example:

"FedEx"

data.carrier_id

string | null

The ID of the carrier for the shipping method.

Example:

"fedex"

data.carrier_name

string | null

The name of the carrier for the shipping method.

Example:

"FedEx"

data.scac

string | null

The Standard Carrier Alpha Code (SCAC) for the shipping method.

Example:

"FDXG"

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"shipping-method.updated"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

previous_attributes

ShippingMethodSchema · object

required

Show child attributes

previous_attributes.id

string

The unique ID of the shipping method.

Example:

"shipping_method_id"

previous_attributes.created_date

string<date-time>

The date the shipping method was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.updated_date

string<date-time>

The date the shipping method was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.name

string

The name of the shipping method.

Example:

"Priority Overnight"

previous_attributes.carrier

string | null

The carrier of the shipping method. Deprecated, use carrier_id instead.

Example:

"FedEx"

previous_attributes.carrier_id

string | null

The ID of the carrier for the shipping method.

Example:

"fedex"

previous_attributes.carrier_name

string | null

The name of the carrier for the shipping method.

Example:

"FedEx"

previous_attributes.scac

string | null

The Standard Carrier Alpha Code (SCAC) for the shipping method.

Example:

"FDXG"

previous_attributes.additional_fields

object

Integration-specific fields

Show child attributes

previous_attributes.additional_fields.{key}

any

Example:

{ "key": "value" }

Response

200

Success

Home

How-To Guides

Use Cases

Shipping method updated

Body

Response