Fulfillments

(ms.fulfillments)

Fulfillments allow the user to split an order into multiple fulfillments to ship different items (and their varying quantity) independently.



Fields

Value Description
fid   
Type: string
The id of the fulfillment.
<p>&nbsp;OID123-F1</p>
oid   
Type: string
OID of the associated order.
status   
Type: string
Status of the fulfillment.
<p>Pending, Shipped, Fulfilled or Cancelled</p>
items   
Type: array
Array of objects containing the details of items in the order.
name
Type: string
variant_id
Type: string
price
Type: string
quantity
Type: string
Quantity of product item.
total
Type: string
item_count   
Type: number
Total number of items in the fulfillment.
sub_total   
Type: number
Sub total amount of the fulfillment.
shipping_charge   
Type: number
Shipping charges applied to the fulfillment.
additional_charge   
Type: number
Additional charges applied to the fulfillment.
discount   
Type: number
tax   
Type: number
total   
Type: number
Total amount of the fulfillment.
tracking_company   
Type: string
Logistics provider used to ship the fulfillment.
service   
Type: string
method   
Type: string
price   
Type: string
Logistics charges applied.
tracking_number   
Type: string
Tracking number of the shipment associated with the fulfillment.
tracking_status   
Type: string
Tracking status of a fulfillment in case it has been shipped, marked as delivered.
shipping_label   
Type: string
Link to shipping label of the shipment.
manifest   
Type: string
Link to manifest of the shipment.
order_id   
Type: string
The record id of the associated orders.
shipment_id   
Type: string
Record id of the shipment associated with the fulfillment (if any).
PickupConfirmationNumber   
Type: string

Commands (Endpoints)

POST /api/1/entity/ms.fulfillments   
Creates a new fulfillment
DEL /api/1/entity/ms.fulfillments/{resource_id}   
Deletes a fulfillment
PUT /api/1/entity/ms.fulfillments/{resource_id}   
Updates an existing fulfillment
GET /api/1/entity/ms.fulfillments/{resource_id}   
Retrieves a single fulfillment
GET /api/1/entity/ms.fulfillments   
Retrieves a list of fulfillments