Update Order Fulfillment

Update an order fulfillment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

  • Required parameters are listed below. For the full list of properties, see Introduction to Orders and Fulfillments.
  • To see an example request, click Examples in the payload on the right.
  • To skip a parameter, enter "null" or exclude it from the payload.
📘

Please note:

It is not necessary to use this endpoint for status updates received already in the e-commerce platform. For example, if the service provider is updating Shopify directly, Yotpo pulls the fulfillment status from there in order to time the review request.

📘

The fulfillment is identified by the IDs in the path, so its external_id can't be changed.

Path Params
string
required

The store ID (app_key).

string
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.

string
required

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

Body Params
fulfillment
object
required

The fulfillment fields to update.

Responses
200

OK. The response has no body.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json