|
AccountId
|
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- ID of the account or person account associated with the FulfillmentOrder.
It represents the shopper in the storefront.
|
|
DeliveryMethodId
|
- Type
- reference
- Properties
- Create, Filter, Group, Sort, Update
- Description
- ID of the delivery method used for this FulfillmentOrder.
|
|
FulfilledFromLocationId
|
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- ID of the location handling this FulfillmentOrder.
|
|
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 and delivery charges
on the FulfillmentOrder. This includes all FulfillmentOrderLineItems
associated with the FulfillmentOrder.
|
|
InvoiceId
|
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- ID of the invoice associated with the FulfillmentOrder.
|
|
IsSuspended
|
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Indicates whether the FulfillmentOrder is suspended.
|
|
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.
|
|
OrderSummaryId
|
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- ID of the OrderSummary associated with the FulfillmentOrder.
|
|
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.
|
|
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)
-
Pickpack (Fulfilling)
|
|
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
|
|
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.
|
|
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 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 code Charge.
|
|
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 code Charge.
|
|
TotalDeliveryTaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the TotalDeliveryAmount.
|
|
TotalProductAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total price of the products on the FulfillmentOrder. This value only
includes FulfillmentOrderLineItems of type code Product.
|
|
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, 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, 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
|