|
AccountId
|
- 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
- Lookup
- Refers To
- Account
|
| ActiveDate |
- Type
- datetime
- Properties
- Filter, Group, Nillable, Sort
- Description
- Date when the fulfillment order becomes active.
- This field is available in API version 61.0 and
later.
|
|
BillToContactId
|
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- ID of the Contact associated with the FulfillmentOrder.
It represents the shopper in the storefront when not
using person accounts.
- This field is available in API version 49.0 and
later.
- This field is a relationship field.
- Relationship Name
- BillToContact
- Relationship Type
- Lookup
- Refers To
- Contact
|
| ClosedDate |
- Type
- datetime
- Properties
- Filter, Group, Nillable, Sort
- Description
- Date the fulfillment order closed. Automatically
entered.
- This field is available in API version 61.0 and
later.
|
|
CurrencyIsoCode
|
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Nillable,
Restricted picklist, Sort, Update
- Description
- Available only for orgs with the multicurrency feature
enabled. ISO code for the currency of the OrderSummary
associated with the FulfillmentOrder.
- Possible values are:
-
DKK—Danish Krone
-
EUR—Euro
-
GBP—British Pound
-
USD—U.S. Dollar
- The default value is USD.
- This field is available in API version 49.0 and
later.
|
|
DeliveryMethodId
|
- Type
- reference
- Properties
- Create, Filter, Group, Sort, Update
- Description
- ID of the DeliveryMethod used for this
FulfillmentOrder.
- This field is a relationship field.
- Relationship Name
- DeliveryMethod
- Relationship Type
- Lookup
- Refers To
- OrderDeliveryMethod
|
|
FulfilledFromLocationId
|
- 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
- Lookup
- Refers To
- Location
|
|
FulfilledToAddress
|
- Type
- address
- Properties
- Filter, Nillable
- Description
- Address of the recipient.
|
|
FulfilledToCity
|
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Recipient address city.
|
|
FulfilledToCountry
|
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Recipient address country.
|
|
FulfilledToEmailAddress
|
- Type
- email
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Email address of the recipient.
|
|
FulfilledToGeocodeAccuracy
|
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist,
Sort, Update
- Description
- Accuracy of the geocode for the recipient address.
- Possible values are:
- Address
- Block
- City
- County
- ExtendedZip
- NearAddress
- Neighborhood
- State
- Street
- Unknown
- Zip
|
|
FulfilledToLatitude
|
- 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.
|
|
FulfilledToLongitude
|
- 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.
|
|
FulfilledToName
|
- Type
- string
- Properties
- Create, Filter, Group, Sort, Update
- Description
- Name on the recipient address.
|
|
FulfilledToPhone
|
- Type
- phone
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Phone number of the recipient.
|
|
FulfilledToPostalCode
|
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Recipient address postal code.
|
|
FulfilledToState
|
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Recipient address state.
|
|
FulfilledToStreet
|
- Type
- textarea
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Recipient address street.
|
|
FulfillmentOrderNumber
|
- Type
- string
- Properties
- Autonumber, Defaulted on create, Filter, idLookup,
Sort
- Description
- ID of the FulfillmentOrder.
|
|
GrandTotalAmount
|
- 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.
|
|
InvoiceId
|
- 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
- Lookup
- Refers To
- Invoice
|
| IsReship |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Indicates whether the FulfillmentOrder is for a
reshipment. The default value is false.
- This field is available in API version 53.0 and
later.
|
|
IsSuspended
|
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Indicates whether the FulfillmentOrder is suspended. The
default value is false.
|
|
ItemCount
|
- Type
- double
- Properties
- Filter, Nillable, Sort
- Description
- Sum of the quantities of the FulfillmentOrderLineItems
included in the FulfillmentOrder.
|
|
LastReferencedDate
|
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- Timestamp for when the current user last viewed a
record related to this record.
|
|
LastViewedDate
|
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- Timestamp for when the current user last viewed this
record. A null value can mean that this record has only
been referenced (LastReferencedDate) and not
viewed.
|
|
OrderId
|
- 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
- Lookup
- Refers To
- Order
|
|
OrderSummaryId
|
- 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
- Lookup
- Refers To
- OrderSummary
|
|
OwnerId
|
- Type
- reference
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- ID of the User who currently owns this FulfillmentOrder.
Default value is the User logged in to the API to
perform the create.
- This field is a polymorphic relationship field.
- Relationship Name
- Owner
- Relationship Type
- Lookup
- Refers To
- Group, User
|
|
Status
|
- 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:
-
Allocated
(Activated)
-
Assigned
(Fulfilling)
-
Cancelled
(Cancelled)
-
Draft
(Draft)
-
Fulfilled
(Closed)
-
Pick
Complete (Fulfilling) This value is
available in API v56.0 and later.
-
Pickpack
(Fulfilling)
-
Printed
(Fulfilling) This value is available in API v56.0
and later.
-
Rejected
(Rejected) This value is available in API v56.0
and later.
|
|
StatusCategory
|
- 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 are:
-
ACTIVATED—Activated
-
CANCELLED—Cancelled
-
CLOSED—Closed
-
DRAFT—Draft
-
FULFILLING—Fulfilling
-
REJECTED—Rejected This value is
available in API v56.0 and later.
|
|
TaxLocaleType
|
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist,
Sort
- 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 are:
-
Gross
(displays most prices and taxes as combined
values)
-
Net
(displays most prices and taxes as separate
values)
- This field is available in API version 49.0 and
later.
|
|
TotalAdjustmentAmount
|
- 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.
|
|
TotalAdjustmentAmtWithTax
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total amount of the price adjustments applied to the
products on the FulfillmentOrder, inclusive of tax. This
value only includes adjustments to
FulfillmentOrderLineItems of type code Product. This
amount is equal to TotalAdjustmentAmount +
TotalAdjustmentTaxAmount.
- This field is available in API version 49.0 and
later.
|
|
TotalAdjustmentTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalAdjustmentAmount.
|
|
TotalAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Adjusted total, not including tax, of the
FulfillmentOrderLineItems, including products, fees, and
delivery charges, on the FulfillmentOrder.
|
|
TotalDeliveryAdjustAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total amount of the price adjustments applied to the
delivery charges on the FulfillmentOrder. This value
only includes adjustments to FulfillmentOrderLineItems
of type Delivery Charge.
|
|
TotalDeliveryAdjustAmtWithTax
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total amount of the price adjustments applied to the
delivery charges on the FulfillmentOrder, inclusive of
tax. This value only includes adjustments to
FulfillmentOrderLineItems of type Delivery Charge. This
amount is equal to TotalDeliveryAdjustAmount +
TotalDeliveryAdjustTaxAmount.
- This field is available in API version 49.0 and
later.
|
|
TotalDeliveryAdjustTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalDeliveryAdjustAmount.
|
|
TotalDeliveryAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total of the delivery charges on the FulfillmentOrder.
This value only includes FulfillmentOrderLineItems of
type Delivery Charge.
|
|
TotalDeliveryAmtWithTax
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- 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.
- This field is available in API version 49.0 and
later.
|
|
TotalDeliveryTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalDeliveryAmount.
|
|
TotalFeeAdjustAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total amount of the price adjustments applied to the
fees on the FulfillmentOrder. This value only includes
adjustments to FulfillmentOrderLineItems of type
Fee.
- This field is available in API version 56.0 and
later.
|
|
TotalFeeAdjustAmtWithTax
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- 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.
- This field is available in API version 56.0 and
later.
|
|
TotalFeeAdjustTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalFeeAdjustAmount.
- This field is available in API version 56.0 and
later.
|
|
TotalFeeAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total amount of the fees on the FulfillmentOrder,
excluding adjustments and tax. This value only includes
FulfillmentOrderLineItems of type Fee.
- This field is available in API version 56.0 and
later.
|
|
TotalFeeAmtWithTax
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- 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.
- This field is available in API version 56.0 and
later.
|
|
TotalFeeTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalFeeAmount.
- This field is available in API version 56.0 and
later.
|
|
TotalProductAmount
|
- 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.
|
|
TotalProductAmtWithTax
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- 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.
- This field is available in API version 49.0 and
later.
|
|
TotalProductTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalProductAmount.
|
|
TotalTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalAmount.
|
|
Type
|
- 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:
-
Download
(Digital)
-
Email
(Digital)
-
In Store
Pickup (Physical)
-
Retail
Store (Physical)
-
Supplier
(Drop Ship)
-
Warehouse
(Physical)
|
|
TypeCategory
|
- 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 are:
-
DIGITAL—Digital
-
DROPSHIP—Drop Ship
-
PHYSICAL—Physical
|
j