Simulate shipment status
curl --request POST \
--url https://sg.sandbox.api.reap.global/simulation/card-shipments/{id}/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Reap-Version: <reap-version>' \
--data '
{
"status": "IN_PRODUCTION"
}
'const options = {
method: 'POST',
headers: {
'Reap-Version': '<reap-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({status: 'IN_PRODUCTION'})
};
fetch('https://sg.sandbox.api.reap.global/simulation/card-shipments/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sg.sandbox.api.reap.global/simulation/card-shipments/{id}/status"
payload = { "status": "IN_PRODUCTION" }
headers = {
"Reap-Version": "<reap-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"error": {
"code": "SIMULATION_INVALID_STATE",
"message": "<string>",
"detail": {}
}
}{
"error": {
"code": "CARD_SHIPMENT_NOT_FOUND",
"message": "<string>",
"detail": {}
}
}Simulation
Simulate shipment status
Simulates a card shipment status change in sandbox. Drives production and shipping progress for a submitted shipment. Returns 204; observe the change via CARD_SHIPMENT_STATUS_UPDATED.
POST
/
simulation
/
card-shipments
/
{id}
/
status
Simulate shipment status
curl --request POST \
--url https://sg.sandbox.api.reap.global/simulation/card-shipments/{id}/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Reap-Version: <reap-version>' \
--data '
{
"status": "IN_PRODUCTION"
}
'const options = {
method: 'POST',
headers: {
'Reap-Version': '<reap-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({status: 'IN_PRODUCTION'})
};
fetch('https://sg.sandbox.api.reap.global/simulation/card-shipments/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sg.sandbox.api.reap.global/simulation/card-shipments/{id}/status"
payload = { "status": "IN_PRODUCTION" }
headers = {
"Reap-Version": "<reap-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"error": {
"code": "SIMULATION_INVALID_STATE",
"message": "<string>",
"detail": {}
}
}{
"error": {
"code": "CARD_SHIPMENT_NOT_FOUND",
"message": "<string>",
"detail": {}
}
}Authorizations
API key as Bearer token
Headers
API version (YYYY-MM-DD)
Available options:
2025-02-14 Example:
"2025-02-14"
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Simulate a card shipment status change
Target shipment status to simulate
Available options:
IN_PRODUCTION, READY_TO_SHIP, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, DELIVERY_FAILED, EXCEPTION, CANCELED Example:
"IN_PRODUCTION"
Response
Response for status 204