Skip to main content
GET
/
product
/
{id}
/
deliveries
/
{deliveryId}
Get Product Delivery Details
curl --request GET \
  --url https://api.royalti.io/product/{id}/deliveries/{deliveryId} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Delivery details retrieved",
  "data": {
    "id": "<string>",
    "provider": "<string>",
    "providerName": "<string>",
    "status": "pending",
    "method": "SFTP",
    "progress": 50,
    "attemptCount": 123,
    "maxAttempts": 123,
    "lastAttemptTime": "2023-11-07T05:31:56Z",
    "nextAttemptTime": "2023-11-07T05:31:56Z",
    "deliveredAt": "2023-11-07T05:31:56Z",
    "remoteStatus": {},
    "deliveryLog": [
      {}
    ],
    "message": {
      "id": "<string>",
      "type": "<string>",
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

/product//deliveries/ Description: Get detailed information about a specific delivery including status, attempts, and error details. Method: GET

Code Examples

const response = await fetch('https://api.royalti.io/product/example-id/deliveries/example-id', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string
required

Product ID

deliveryId
string
required

Delivery ID

Response

Delivery details retrieved

status
string
Example:

"success"

message
string
Example:

"Delivery details retrieved"

data
object