Newer Version Available

This content describes an older version of this product. View Latest

ShippingCarrierMethodId

Shipping service provided by a shipping carrier. Examples include Ground, 2Day, and NextDay. Service depends on the range of transit times available for each carrier. This object is available in API version 51.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

The ShippingCarrierMethodId object is available only if the B2B Commerce or D2C Commerce license is enabled.

Fields

Field Details
Name
Type
text
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of the shipping carrier associated with the delivery.
ExternalReference
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Unique code, reference, or identifier for the shipping carrier associated with the delivery. Can be used for internal tracking or integration purposes.
MinimumTransitTime
Type
integer
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Required. Minimum amount of time required for the carrier to transport and deliver an order. Measured in a specific unit, such as days, hours, or weeks.
For example, if the minimum transit time is set to 1, the carrier takes at least 1 unit of the specified transit time unit to deliver the order.
MaximumTransitTime
Type
integer
Properties
Create, Filter, Group, Sort, Update
Description
Required. Maximum amount of time required for the carrier to transport and deliver an order. Measured in a specific unit, such as days, hours, or weeks.
For example, if the maximum transit time is set to 3, the carrier takes no more than 3 units of the specified transit time unit to deliver the order.
TransitTimeUnit
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Required. Unit of measurement used for transit time. Specifies the time interval in which the minimum and maximum transit times are expressed.
The available options are:
  • Day
  • Hour
  • Week
ShippingCarrier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Company or service responsible for transporting and delivering the order to the customer.