Response codes
When you submit an order, and we accept it then you’ll receive a status code 202. This is a synchronous response.
This response lets you know we have received your order but we are yet to action it. Next, your order will move to the ‘acknowledged’ stage or it may get rejected.
Order stages
In this section, you’ll find an overview of successful order notifications. In total, there are three asynchronous notifications in a successful order journey, including:
- acknowledged
- inProgress
- completed
Successful order notifications
In this section, you’ll find sample order notifications for activating an existing SIM. We’ll add the successful order notifications for activating a new digital eSIM in the future.
Acknowledgement
After we accept the order, and acknowledge it, then you’ll receive a ProductOrderCreateEvent. Notification. This notification includes a product order id, our reference, for the order and an external id which is your reference.
Acknowledged sample JSON
{
"eventId": "9b38d483-7818-479c-957f-3f40eb620944",
"eventTime": "2025-02-11T11:40:48.407241+00:00",
"eventType": "ProductOrderCreateEvent",
"event": {
"productOrder": {
"id": "00013856",
"state": "acknowledged",
"externalId": "9024f5b0-0481-45b2-bd98-5b1a7aaca51f",
"productOrderItem": [],
"relatedParty": [
{
"id": "5751",
"role": "AccountNumber",
"@type": "BTRelatedParty",
"@referredType": "Customer"
},
{
"id": "4415",
"role": "SubscriptionAccountCode",
"@type": "BTRelatedParty",
"@referredType": "Customer"
}
]
}
}
}In progress
When an order is in progress, you’ll receive a ProductOrderStateChangeEvent notification.
InProgress sample JSON
{
"eventId": "CMP-RESELLER-11-02-2025T125629",
"eventTime": "2025-02-11T12:56:29.006+0000",
"eventType": "ProductOrderStateChangeEvent",
"event": {
"productOrder": {
"id": "00013856",
"productOrderItem": [
{
"id": "1.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11979",
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"@type": "BTMobileSubscriptionProduct"
},
"state": "inProgress",
"@type": "BTProductOrderItem"
}
],
"relatedParty": [
{
"id": "5751",
"role": "AccountNumber",
"@type": "BTRelatedParty",
"@referredType": "Customer"
},
{
"id": "4415",
"role": "SubscriptionAccountCode",
"@type": "BTRelatedParty",
"@referredType": "Customer"
}
],
"state": "inProgress",
"externalId": "9024f5b0-0481-45b2-bd98-5b1a7aaca51f"
}
}
}
Completed
Once the order is complete, you’ll receive a ProductOrderStateChangeEvent notification.
Completed sample JSON
{
"eventId": "CMP-RESELLER-11-02-2025T024850",
"eventTime": "2025-02-11T14:48:50.149+0000",
"eventType": "ProductOrderStateChangeEvent",
"event": {
"productOrder": {
"id": "00013863",
"productOrderItem": [
{
"id": "1.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11985",
"productCharacteristic": [
{
"name": "ServiceNumber",
"value": "07414005072"
}
],
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"productRelationship": [
{
"relationshipType": "SIMForSubscription",
"product": {
"id": "4600600600620",
"@type": "BTMobileSIMProduct"
}
}
],
"@type": "BTMobileSubscriptionProduct"
},
"state": "completed",
"@type": "BTProductOrderItem"
}
],
"relatedParty": [
{
"id": "5751",
"role": "AccountNumber",
"@type": "BTRelatedParty",
"@referredType": "Customer"
},
{
"id": "4415",
"role": "SubscriptionAccountCode",
"@type": "BTRelatedParty",
"@referredType": "Customer"
}
],
"state": "completed",
"externalId": "56d6e80a-e830-4e76-b4b2-69fc568e6736"
}
}
}
Key order details
After you’ve completed an order, we recommend you make a note of the following details for future reference:
- ProductOrder id
- Service number
- SIM serial number
- Subscription number
- External id
These details will help if you want to match the requests with responses. Plus, you can check on the progress of an order using the ProductOrder id.
You may need to use these details if you’d like to make changes in the future, for example to modify an order. Note: this functionality is not available right now but will be in the future.
Multiple subscriptions
If you order multiple subscriptions, you’ll receive order status event notifications when different parts of the order change from in progress to completed.
Note: if any of your subscriptions fail then you will need to submit a new order as it’s not possible to update parts of your order.
Order status change events
The following sample event notifications are for activating an existing SIM only. We’ll update you with sample event notifications for activating a new digital eSIM in the future.
inProgress
You’ll receive one notification when an order with multi subscriptions is in progress.
InProgress sample JSON
{
"eventId":"CMP-RESELLER-12-02-2025T113132",
"eventTime":"2025-02-12T11:31:32.393+0000",
"eventType":"ProductOrderStateChangeEvent",
"event": {
"productOrder": {
"id" : "00013868",
"productOrderItem": [
{
"id":"1.0",
"quantity":1,
"action":"add",
"product":{
"id":"11990",
"productOffering":{
"id":"SUB",
"@type":"BTMobileSubscriptionProductOffering"
},
"@type":"BTMobileSubscriptionProduct"
},
"state":"inProgress",
"@type":"BTProductOrderItem"
},
{
"id":"2.0",
"quantity":1,
"action":"add",
"product":{
"id":"11991",
"productOffering":{
"id":"SUB",
"@type":"BTMobileSubscriptionProductOffering"
},
"@type":"BTMobileSubscriptionProduct"
},
"state":"inProgress",
"@type":"BTProductOrderItem"
},
{
"id":"3.0",
"quantity":1,
"action":"add",
"product":{
"id":"11992",
"productOffering":{
"id":"SUB",
"@type":"BTMobileSubscriptionProductOffering"
},
"@type":"BTMobileSubscriptionProduct"
},
"state":"inProgress",
"@type":"BTProductOrderItem"
}
],
"relatedParty":[
{
"id":"5751",
"role":"AccountNumber",
"@type":"BTRelatedParty",
"@referredType":"Customer"
},
{
"id":"4415",
"role":"SubscriptionAccountCode",
"@type":"BTRelatedParty",
"@referredType":"Customer"
}
],
"state":"inProgress",
"externalId":"68fd36e5-399e-4308-8a42-0dc07960c0a3"
}
}
}
One subscription completed (others in progress)
As part of the inProgress stage, you will receive an update after each subscription is complete.
For example, if you have submitted an order with three subscriptions then you’ll get an update about each subscription one at a time. Each notification tells you which subscriptions are still in progress and which ones are complete.
One completed subscription sample JSON
{
"eventId": "CMP-RESELLER-12-02-2025T114010",
"eventTime": "2025-02-12T11:40:10.666+0000",
"eventType": "ProductOrderStateChangeEvent",
"event": {
"productOrder": {
"id": "00013868",
"productOrderItem": [
{
"id": "1.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11990",
"productCharacteristic": [
{
"name": "ServiceNumber",
"value": "07414005074"
}
],
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"productRelationship": [
{
"relationshipType": "SIMForSubscription",
"product": {
"id": "4600600600622",
"@type": "BTMobileSIMProduct"
}
}
],
"@type": "BTMobileSubscriptionProduct"
},
"state": "completed",
"@type": "BTProductOrderItem"
},
{
"id": "2.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11991",
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"@type": "BTMobileSubscriptionProduct"
},
"state": "inProgress",
"@type": "BTProductOrderItem"
},
{
"id": "3.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11992",
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"@type": "BTMobileSubscriptionProduct"
},
"state": "inProgress",
"@type": "BTProductOrderItem"
}
],
"relatedParty": [
{
"id": "5751",
"role": "AccountNumber",
"@type": "BTRelatedParty",
"@referredType": "Customer"
},
{
"id": "4415",
"role": "SubscriptionAccountCode",
"@type": "BTRelatedParty",
"@referredType": "Customer"
}
],
"state": "inProgress",
"externalId": "68fd36e5-399e-4308-8a42-0dc07960c0a3"
}
}
}
All subscriptions completed
Your order will move to completed once every subscription in the order has been successful. You’ll receive one notification like the following.
All subscriptions completed sample JSON
{
"eventId": "CMP-RESELLER-12-02-2025T115156",
"eventTime": "2025-02-12T11:51:56.199+0000",
"eventType": "ProductOrderStateChangeEvent",
"event": {
"productOrder": {
"id": "00013868",
"productOrderItem": [
{
"id": "1.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11990",
"productCharacteristic": [
{
"name": "ServiceNumber",
"value": "07414005074"
}
],
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"productRelationship": [
{
"relationshipType": "SIMForSubscription",
"product": {
"id": "4600600600622",
"@type": "BTMobileSIMProduct"
}
}
],
"@type": "BTMobileSubscriptionProduct"
},
"state": "completed",
"@type": "BTProductOrderItem"
},
{
"id": "2.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11991",
"productCharacteristic": [
{
"name": "ServiceNumber",
"value": "07414005075"
}
],
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"productRelationship": [
{
"relationshipType": "SIMForSubscription",
"product": {
"id": "4600600600623",
"@type": "BTMobileSIMProduct"
}
}
],
"@type": "BTMobileSubscriptionProduct"
},
"state": "completed",
"@type": "BTProductOrderItem"
},
{
"id": "3.0",
"quantity": 1,
"action": "add",
"product": {
"id": "11992",
"productCharacteristic": [
{
"name": "ServiceNumber",
"value": "07414005076"
}
],
"productOffering": {
"id": "SUB",
"@type": "BTMobileSubscriptionProductOffering"
},
"productRelationship": [
{
"relationshipType": "SIMForSubscription",
"product": {
"id": "4600600600624",
"@type": "BTMobileSIMProduct"
}
}
],
"@type": "BTMobileSubscriptionProduct"
},
"state": "completed",
"@type": "BTProductOrderItem"
}
],
"relatedParty": [
{
"id": "5751",
"role": "AccountNumber",
"@type": "BTRelatedParty",
"@referredType": "Customer"
},
{
"id": "4415",
"role": "SubscriptionAccountCode",
"@type": "BTRelatedParty",
"@referredType": "Customer"
}
],
"state": "completed",
"externalId": "68fd36e5-399e-4308-8a42-0dc07960c0a3"
}
}
}