Sync your store order fulfillments to Yotpo. Order fulfillments represent a group of one or more items in an order that are to be fulfilled from the same location. A fulfillment represents work that is completed as part of a fulfillment order and can include one or more items.
Order fulfillments endpoints are available for Yotpo Reviews and Yotpo SMS & Email.
Order fulfillment endpoints
- Create order fulfillment - Create an order fulfillment in your Yotpo store.
- Update order fulfillment - Update an order fulfillment in your Yotpo store.
- Retrieve order fulfillments - Retrieve a list of fulfillments for an order in your Yotpo store.
- Retrieve fulfillment by ID - Retrieve a fulfillment by store ID, order ID, and fulfillment ID.
Order fulfillment properties
Listed below are all of the available properties for order fulfillments. To see which properties are required per endpoint, refer to the endpoint pages below.
| Field | Type | Description |
|---|---|---|
| external_id | string | The merchant's unique ID for the fulfillment. |
| fulfillment_date | datetime | The date the fulfillment was created. Required for sending review requests. |
| status | string | The status of the fulfillment. Valid values: - pending - open - success - cancelled - error - failure Required for sending review requests (must be set to "success"). |
| yotpo_id | integer | The ID generated by Yotpo for the fulfillment. This field is read-only. |
| shipment_info | object | The shipping info object. See Shipment info below. |
| fulfilled_items | array of objects | Information about the specific items fulfilled (i.e. product and quantity). Items within an order may be fulfilled separately. All fullfillment actions related to the order can be synced to Yotpo. This allows Yotpo to trigger messaging automations or product review requests at the right moment. Providing a fulfillment with an external product ID that is not included in the order will result in a bad request. |
| created_at | datetime | The time the fulfillment was first synced to Yotpo. This field is read-only. |
| updated_at | datetime | The time the fulfillment was last updated in Yotpo. This field is read-only. |
Shipment info
| Field | Type | Description |
|---|---|---|
| shipment_status | string | The current shipment status of the fulfillment. Valid values: - label_printed - label_purchased - attempted_delivery - ready_for_pickup - confirmed - in_transit - out_for_delivery - delivered - failure |
| tracking_company | string | The name of the tracking company. |
| tracking_url | string | The URL of the tracking page for the shipment. |
| tracking_number | string | The tracking number as provided by the shipping company. |
Fulfilled Items
| Field | Type | Description |
|---|---|---|
| external_product_id | string | The merchant's unique ID for the product. |
| quantity | integer | The quantity actually fulfilled. |