Journey Docs
Partner API ExplorerFulfillments

Get a fulfillment

Required scopepartner:fulfillments:read
GET
/v1/partner/fulfillments/{fulfillmentId}

Full detail for one fulfillment.

Authorization

headerAuthorizationBearer <token>

WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.

Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected with 401 Invalid or expired token; send it in X-API-Key instead.

WorkOS organization API keys are not accepted yet.

Path Parameters

fulfillmentId*string

External fulfillment id (UUID).

Formatuuid

Response Body

The fulfillment.

application/json
  1. response
approvalStatus?string
canApprove*boolean
claimedAt?string
contactEmail?string
createdAt*string
displayName*string
expiresAt?string
fulfilledAt?string
id*string
memberId?number
offerDescription?string
offerId?string
offerImageUrl?string
offerName?string
organizationId?number
organizationName?string
perkDescription?string
perkId?number
perkImageUrl?string
perkName?string
pointsCharged?number
propertyId?number
propertyName?string
qrCodeUrl?string
redemptionType?string
requestedCheckInTime?string
requestedCheckOutTime?string
reservationId?number
retailValue?number
source*string
status*string
updatedAt*string
verificationCode?string
curl -X GET 'https://api-prd.cf.journey.com/v1/partner/fulfillments/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "approvalStatus": "string",  "canApprove": true,  "claimedAt": "string",  "contactEmail": "string",  "createdAt": "string",  "displayName": "string",  "expiresAt": "string",  "fulfilledAt": "string",  "id": "string",  "memberId": 0,  "offerDescription": "string",  "offerId": "string",  "offerImageUrl": "string",  "offerName": "string",  "organizationId": 0,  "organizationName": "string",  "perkDescription": "string",  "perkId": 0,  "perkImageUrl": "string",  "perkName": "string",  "pointsCharged": 0,  "propertyId": 0,  "propertyName": "string",  "qrCodeUrl": "string",  "redemptionType": "string",  "requestedCheckInTime": "string",  "requestedCheckOutTime": "string",  "reservationId": 0,  "retailValue": 0,  "source": "string",  "status": "string",  "updatedAt": "string",  "verificationCode": "string"}