Update fulfillment status

post
/fulfillments/{id}/update-status

Updating the fulfillment status by fulfillment ID.

The fulfillment status must be updated in a specific sequence according to the fullfilment delivery method (fulfillment.delivery_method).

For shipping fulfillment, the statuses should be updated in the following order:

Note: Updating the status in reverse, such as updating from shipped to processing, is not permitted.

Similarly, for pickup fulfillment, the statuses should be updated in the following order:

The provided status sequences do not include any custom statuses. For custom statuses, please adhere to the sequence configured in the AfterShip Admin Portal.

Ensure that statuses are updated in the prescribed order to avoid any discrepancies.

id
string
required

The ID of the fulfillment.

as-store-id
string
required

This value equals to store.id of Store Resource. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.

status
string
required

The status of the fulfillment. Depending of on the delivery_method, the allowed values are different.Show all...

Example:
pending
occurred_at
string<date-time>
required

Indicates the time the status was updated, showing when the Doege occurred for the fulfillment, formatted in ISO 8601.

Example:
2021-04-15T20:02:09Z
Auth
:
Parameters
:
:
Body
preparing...