v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Retrieve Order Fulfillments

Retrieve a list of fulfillments for an order.

get/core/v3/stores/{store_id}/orders/{yotpo_order_id}/fulfillments

Path parameters

store_idstring required

The store ID (app_key).

yotpo_order_idstring required

The Yotpo ID for the order. This ID is created automatically upon creation of the order. You can find it by using the Retrieve endpoint.

Query parameters

access_tokenstring required

Your Yotpo access token. Click here to learn how to generate one

page_infostring

Encoded page info.

limitinteger

Defines how many results will be returned per page.

external_idsstring

Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be <a href="https://www.urlencoder.io/learn" target="_blank">URL encoded</a>. Max 100 IDs. Can't come with page_info or limit.

Response

200

Example response

{
  "fulfillments": [
    {
      "external_id": "string",
      "yotpo_order_id": "string",
      "fulfillment_date": "2021-03-31T11:58:51Z",
      "status": "pending",
      "created_at": "2021-03-25T13:57:05Z",
      "updated_at": "2021-03-26T13:57:05Z",
      "shipment_info": {
        "shipment_status": "label_printed",
        "tracking_company": "string",
        "tracking_url": "string",
        "tracking_number": "string"
      },
      "fulfilled_items": [
        {
          "yotpo_product_id": 2145,
          "external_product_id": "sd24tvas"
        }
      ]
    }
  ],
  "pagination": {
    "next_page_info": "string"
  }
}