Status
The /activities/{activityUuid}
endpoint contains the status
property:
{
[...],
"status": "ONLINE",
[...]
}
This property determines whether an activity is available for purchase or not.
Publication flow
The typical publication flow for an activity is as follows:
-
DRAFT
The default status for a new activity. It means an activity provider is still setting up the activity and that it is not available for purchase.
-
REVIEW
After an activity provider has finished creating their activity, they submit it to Musement for review. The activity is not available for purchase yet.
-
ONLINE
The activity has been published and is ready for purchase.
When an activity is no longer available
The status of an ONLINE
activity can change when an activity is no longer available. Musement uses two statuses, UNAVAILABLE
and ARCHIVED
, to indicate when an activity is no longer available for purchase and should not be shown to customers.
UNAVAILABLE
When there are no more available dates the activity status automatically changes to UNAVAILABLE
. The activity is removed from search endpoints, such as /activities
, but can still be accessed directly at endpoints such as /activities/{activityUuid}
.
This status may be temporary due to seasonal availability. However, the status could be permanent if the activity is no longer offered by the provider.
ARCHIVED
Musement may change the status from ONLINE
to ARCHIVED
, which has the same effects as UNAVAILABLE
.
This status may be permanent if the activity is no longer offered by the provider. However, this status is also used to block sales while important updates are applied to the content and availability.
Error responses
Partners cannot access activities with a status of DRAFT
and REVIEW
. These activities do not appear in the catalog and attempts to call endpoints for these activities directly will result in a 403 status code response:
{
"code": "0",
"message": "You don't have permission to access this resource."
}
This response applies to the following endpoints:
-
/activities/{activityUuid}
-
/activities/{activityUuid}/bundles
-
/activities/{activityUuid}/dates
-
/activities/{activityUuid}/dates/{date}
-
/activities/{activityUuid}/destinations
-
/activities/{activityUuid}/extra-customer-data/schema
-
/activities/{activityUuid}/flavours
-
/activities/{activityUuid}/languages
-
/activities/{activityUuid}/media
-
/activities/{activityUuid}/participants-info/schema
-
/activities/{activityUuid}/pickups
-
/activities/{activityUuid}/refund-policies
-
/activities/{activityUuid}/safety-information
-
/activities/{activityUuid}/taxonomies
Usually, once an activity has a status of ONLINE
it will not change to DRAFT
or REVIEW
. However, this can still happen and partners should be aware that as a result access to an activity can change.
Activities with a status of ARCHIVED
or UNARCHIVED
, while removed from the catalog, can still be accessed directly with most of the endpoints above.
However, the /activities/{activityUuid}/dates
and /activities/{activityUuid}/dates/{date}
endpoints will return a 403 status code response:
{
"code": "6002",
"message": "You cannot access dates for an archived activity"
}
Changes in 3.5.0
The endpoint /activities/{activityUuid}/languages
does not exist in version 3.5.0.