ShippingCarrierMethod

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.

Introduced in API version 61.0.

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

  • The ShippingCarrierMethodId object is available only if the B2B Commerce or D2C Commerce license is enabled.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Unique code, reference, or identifier for the shipping carrier associated with the delivery. Can be used for internal tracking or integration purposes.
  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 65.0
  • Description: Salesforce-managed shipping carrier method that provides estimated transit times.

  • Type: int

  • Properties: Create, Filter, Group, Sort, Update

  • Description:

    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.

  • Type: int

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    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.

  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the shipping carrier associated with the delivery.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 67.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 67.0
  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    Id of the company or service responsible for transporting and delivering the order to the customer.

    This is a relationship field.

  • Relationship name: ShippingCarrier

  • Relationship type: relationship

  • Refers to: ShippingCarrier

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 65.0

  • Description:

    Type of shipping carrier method.

    The default value is Domestic.

  • Possible values:

    • Domestic — Domestic (default)
    • DomesticAndInternational — DomesticAndInternational
    • International — International

  • Default value: Domestic

  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0
  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description:

    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:

  • Possible values:

    • Days — Days
    • Hours — Hours
    • Weeks — Weeks
  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0
  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.