The fulfillment resource represents fulfillment of orders. Every physical order is associated with a fulfillment.
The fulfillment resource can be used directly by shop owners and also by shipping partners on behalf of shop owners.
What can you do with Fulfillment?
The FlickRocket API lets you do the following with the fulfillment resource. More detailed versions of these general actions may be available:
GET /api/fulfillments.json
Receive a list of all order fulfillments of the current shop.
GET /api/fulfillments.json?created_at_min=2015-07-01T00:00:00&created_at_max= 2015-07-02T00:00:00
Receive a list of order fulfillments of the current shop for orders made between 2017-07-01 to 2015-07-02.
GET /api/fulfillments/count.json
Receive the current shop's physical order count.
GET /api/fulfillments/open.json
Receive a list of all order fulfillments of the current shop which are still open.
GET /api/fulfillments/complete.json
Receive a list of all completed order fulfillments.
GET /api/fulfillments/#{token}.json
Receive specific fulfillment identified by Order ID.
PUT /api/fulfillments/#{token}.json
Modify a specific fulfillment identified by Order ID.
| created_at |
"2014-07-02T13:25:26" The date/time the order for this fulfilment was made. |
| customer |
Customer data for shipment. {
"country_name":"United States of America" "country_code":"US" "default":true "province_code":"California" "province":"CA" "name":"John Doe" "id":15475 "first_name":"John" "last_name":"Doe", "company":"" "address1":"18914, Coast Street" "address2":"" "zip":"77073" "city":"Houston" "token":"NNYAHQNTOAPYBNAK" } |
| id |
"105489" The unique id of this fulfillment/order. |
| line_items |
Array of line items for fulfillment [{ "id":75501 The internal ID of this product. "product_id":"0001-26ED-EA4F-AA32" The long ID of the products as displayed in the admin interface "title":"TheGoodFather" The title of this product. "version":"1.0" The version of this product (if specified) "Quantity":2 The ordered quantity of this product. "gtin":"" The GTIN number of this product (if specified). "weight":160 The weight of the product in gram }] |
| owner_company |
1212345 The company id of the company for which the shipping must be done. |
|
status |
100 0 = Not shipped / 100 = Shipped |
| tracking_company |
"DHL" The name of the shipping model (read-only). |
| tracking_number |
"122ur4538ef29, 122fr4539gh27" The tracking number(s) for this fulfillment. Max. 64 characters. |
| tracking_url |
"https://www.dhl.com/en/express/tracking.html" The URL used for tracking this shipment (if possible) as defined in the selected shipping model (read only) |