Once an order has been paid, you need to wait for its status to change.
An order's status property is dependent on all its order items, only changing after every order item has been confirmed. Since order items can come from activities with differing characteristics, such as confirmation times or refund policies, we recommend tracking the status property for individual items instead of the order's own status property.
After a successful payment, order items for instant confirmation activities automatically change their status from PENDING to OK.
Need confirmation activities do not automatically change their status after a successful payment. Their status changes after the activity provider reviews and confirms the booking. The amount of time for this step varies, depending on the activity provider. The order item's product indicates the maximum amount of wait time to expect for a confirmation in its max_confirmation_time property.
To check the current status of an order and its items, retrieve the order by UUID:
curl -X GET '{baseUrl}/orders/{orderUuid}' \
-H 'X-Musement-Application: {applicationValue}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer {accessToken}'The response includes the order-level status and each item's individual status. For the full response structure, see Order creation.
The status-relevant fields are:
| Field | Description |
|---|---|
status | The order's overall status. |
items[].status | The individual order item's status. |
items[].vouchers | Download URLs, populated only when the item status is OK. |
items[].product.max_confirmation_time | Maximum wait time for confirmation (ISO 8601 duration). |
If you have set up a webhook for order items, you can trigger a notification by making the following request:
curl -X POST '{baseUrl}/orders/{orderUuid}/items/{orderItemUuid}/notifications' \
-H 'X-Musement-Application: {applicationValue}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer {accessToken}'Webhook notifications are sent automatically when an order item transitions to any of the following statuses: OK, KO, PENDING, REFUNDED, CANCELLATION_ERROR, or REFUND_STARTED.
A complete list of order and order item statuses is available in the reference section and below.
The following table shows all possible status values and what they mean:
| Public status | Description |
|---|---|
OK | The order is valid and all order items have been confirmed. |
PENDING | The order's payment and/or item confirmation are in progress. |
KO | There was an issue finalizing the order, or it has been cancelled without a refund. |
REFUND_STARTED | A refund request for one or more order items is being processed. This status is temporary and will change to REFUNDED once the request has been resolved. |
REFUNDED | The order has been cancelled and either partially or fully refunded. Both partial and full refunds result in this status. |
Each order item has its own status that reflects the booking state for that specific product. The following table shows all possible status values:
| Public status | Description |
|---|---|
OK | The order item is valid and has been confirmed. Vouchers are available for download. |
PENDING | The order item's payment and confirmation are in progress. |
KO | There was an issue finalizing the order item. |
REFUND_STARTED | A refund request for the item is being processed. This status is temporary and will change to REFUNDED once the request has been resolved. |
REFUNDED | The order item has been cancelled and either partially or fully refunded. |
CANCELLATION_ERROR | An error occurred while processing a cancellation. This status is temporary and will change to either OK or REFUNDED after examination by Musement Customer Care. |