FulfillmentOrder

Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary.

Introduced in API version 48.0.

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

  • This object is only available in Salesforce Order Management orgs.

  • Type: reference

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

  • Description:

    ID of the Account or Person Account associated with the FulfillmentOrder. It represents the shopper in the storefront.

    This field is a relationship field.

  • Relationship name: Account

  • Relationship type: relationship

  • Refers to: Account

  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 61.0

  • Type: reference

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

  • Introduced: API version 49.0

  • Description:

    ID of the Contact associated with the FulfillmentOrder. It represents the shopper in the storefront when not using person accounts.

    This field is a relationship field.

  • Relationship name: BillToContact

  • Relationship type: relationship

  • Refers to: Contact

  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 61.0
  • Description: Date the FulfillmentOrder closed. Automatically entered.

  • Type: datetime

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

  • Introduced: API version 65.0

  • Description:

    The date and time when the FulfillmentOrder was delivered.

    This field is a relationship field.

  • Type: reference

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

  • Description:

    ID of the DeliveryMethod used for this FulfillmentOrder.

    This field is a relationship field.

  • Relationship name: DeliveryMethod

  • Relationship type: relationship

  • Refers to: OrderDeliveryMethod

  • Type: reference

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

  • Description:

    ID of the Location handling this FulfillmentOrder.

    This field is a relationship field.

  • Relationship name: FulfilledFromLocation

  • Relationship type: relationship

  • Refers to: Location

  • Type: address
  • Properties: Filter, Nillable
  • Description: Address of the recipient.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Recipient address city.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Recipient address country.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Email address of the recipient.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Accuracy of the geocode for the recipient address.
  • Possible values:
    • Address — Address
    • Block — Block
    • City — City
    • County — County
    • ExtendedZip — ExtendedZip
    • NearAddress — NearAddress
    • Neighborhood — Neighborhood
    • State — State
    • Street — Street
    • Unknown — Unknown
    • Zip — Zip
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with FulfilledToLongitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with FulfilledToLatitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Name on the recipient address.
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Phone number of the recipient.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Recipient address postal code.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Recipient address state.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Recipient address street.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: ID of the FulfillmentOrder.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total, including adjustments and tax, of the products, fees, and delivery charges on the FulfillmentOrder. This amount includes all FulfillmentOrderLineItems associated with the FulfillmentOrder. This amount is equal to TotalAmount + TotalTaxAmount.

  • Type: reference

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

  • Description:

    ID of the Invoice associated with the FulfillmentOrder.

    This field is a relationship field.

  • Relationship name: Invoice

  • Relationship type: relationship

  • Refers to: Invoice

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 53.0
  • Description: Indicates whether the FulfillmentOrder is for a reshipment. The default value is false.
  • Default value: false
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the FulfillmentOrder is suspended. The default value is false.
  • Default value: false
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Sum of the quantities of the FulfillmentOrderLineItems included in the FulfillmentOrder.

  • Type: reference

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

  • Description:

    ID of the original Order that generated the FulfillmentOrder.

    This field is a relationship field.

  • Relationship name: Order

  • Relationship type: relationship

  • Refers to: Order

  • Type: reference

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

  • Description:

    ID of the OrderSummary associated with the FulfillmentOrder.

    This field is a relationship field.

  • Relationship name: OrderSummary

  • Relationship type: relationship

  • Refers to: OrderSummary

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 65.0
  • Description: How many minutes it took to process the FulfillmentOrder, from the start of processing to completion.

  • Type: reference

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

  • Introduced: API version 67.0

  • Relationship name: ServiceRequest

  • Relationship type: relationship

  • Refers to: ServiceRequest

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 65.0
  • Description: The date and time when the fulfillment process was started for the FulfillmentOrder.

  • Type: picklist

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

  • Description:

    Status of the FulfillmentOrder. Each status corresponds to one status category, shown here in parentheses. You can customize the status picklist to represent your business processes, but the status category picklist is fixed because processing is based on those values. If you customize the status picklist, include at least one status value for each status category.

    Default values are:

  • Possible values:

    • Allocated — Allocated
    • Assigned — Assigned
    • Cancelled — Cancelled
    • Draft — Draft
    • Fulfilled — Fulfilled
    • Pick Complete — Pick Complete
    • Pickpack — Pickpack
    • Printed — Printed
    • Rejected — Rejected
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Description: Status category of the FulfillmentOrder. Processing of the FulfillmentOrder depends on this value. Each status category corresponds to one or more statuses.
  • Possible values:
    • ACTIVATED — ACTIVATED
    • CANCELLED — CANCELLED
    • CLOSED — CLOSED
    • DRAFT — DRAFT
    • FULFILLING — FULFILLING
    • REJECTED — REJECTED — Rejected This value is available in API v56.0 and later.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 49.0
  • Description: The system used to handle tax on the original Order associated with the FulfillmentOrder. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax.
  • Possible values:
    • Gross — Gross
    • Net — Net
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total amount of the price adjustments applied to the products on the FulfillmentOrder. This value only includes adjustments to FulfillmentOrderLineItems of type code Product, not adjustments to delivery charges or fees.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total amount of the price adjustments applied to the products on the Fulfillment Order, inclusive of tax. This value only includes adjustments to FulfillmentOrderLineItems of type code Product. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalAdjustmentAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Adjusted total, not including tax, of the FulfillmentOrderLineItems, including products, fees, and delivery charges, on the Fulfillment Order.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total amount of the price adjustments applied to the delivery charges on the Fulfillment Order. This value only includes adjustments to FulfillmentOrderLineItems of type Delivery Charge.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total amount of the price adjustments applied to the delivery charges on the Fulfillment Order, inclusive of tax. This value only includes adjustments to FulfillmentOrderLineItems of type Delivery Charge. This amount is equal to TotalDeliveryAdjustAmount + TotalDeliveryAdjustTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalDeliveryAdjustAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total of the delivery charges on the FulfillmentOrder. This value only includes FulfillmentOrderLineItems of type Delivery Charge.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total amount of the delivery charges on the FulfillmentOrder, inclusive of tax. This value only includes FulfillmentOrderLineItems of type Delivery Charge. This amount is equal to TotalDeliveryAmount + TotalDeliveryTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalDeliveryAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Total amount of the price adjustments applied to the fees on the FulfillmentOrder. This value only includes adjustments to FulfillmentOrderLineItems of type Fee.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Total amount of the price adjustments applied to the fees on the FulfillmentOrder, inclusive of tax. This value only includes adjustments to FulfillmentOrderLineItems of type Fee. This amount is equal to TotalFeeAdjustAmount + TotalFeeAdjustTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Tax on the TotalFeeAdjustAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Total amount of the fees on the FulfillmentOrder, excluding adjustments and tax. This value only includes FulfillmentOrderLineItems of type Fee.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Total price of the fees on the FulfillmentOrder, inclusive of tax. This value only includes FulfillmentOrderLineItems of type Fee. This amount is equal to TotalFeeAmount + TotalFeeTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Tax on the TotalFeeAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total price of the products on the FulfillmentOrder, excluding order adjustments, delivery charges, and fees. This value only includes FulfillmentOrderLineItems of type code Product.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total price of the products on the FulfillmentOrder, inclusive of tax. This value only includes FulfillmentOrderLineItems of type code Product. This amount is equal to TotalProductAmount + TotalProductTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalProductAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalAmount.

  • Type: picklist

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

  • Description:

    Type of the FulfillmentOrder. Each type corresponds to one type category, shown here in parentheses. You can customize the type picklist to represent your business processes, but the type category picklist is fixed because processing is based on those values. If you customize the type picklist, include at least one type value for each type category.

    Default values are:

  • Possible values:

    • Download — Download
    • Email — Email
    • In Store Pickup — In Store Pickup
    • Retail Store — Retail Store
    • Supplier — Supplier
    • Warehouse — Warehouse
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Type category of the FulfillmentOrder. Processing of the FulfillmentOrder depends on this value. Each type category corresponds to one or more types.
  • Possible values:
    • DIGITAL — DIGITAL
    • DROPSHIP — DROPSHIP — Drop Ship
    • PHYSICAL — PHYSICAL

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.