GET
/
v1
/
order
/
{id}
Get a purchase order by ID
curl --request GET \
  --url https://public.api.collectpure.com/v1/order/{id} \
  --header 'x-api-key: <api-key>'
{
  "status": "<string>",
  "subtotal": 123,
  "total": 123,
  "salesTax": 123,
  "currency": "<string>",
  "processingFee": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "shippingLabelUrl": "<string>",
  "payoutMethod": "<string>",
  "lineItems": [
    {
      "id": 123,
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productTitle": "<string>",
      "variantTitle": "<string>",
      "price": 123,
      "quantity": 123,
      "status": "<string>",
      "spotPremium": 123,
      "spotPremiumDollar": 123
    }
  ],
  "trackers": [
    {
      "status": "<string>",
      "weight": 123,
      "carrier": "<string>",
      "delivered": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "lineItems": [
        {
          "id": 123,
          "quantity": 123
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "totalValue": 123,
      "statusDetail": "<string>",
      "trackingCode": "<string>",
      "service": "<string>",
      "containerType": "<string>",
      "estDeliveryDate": "<string>",
      "currentLocation": "<string>"
    }
  ]
}
Retrieve detailed information about a specific purchase order by its ID. This endpoint returns comprehensive data about the order including its status, financial details, line items, and shipping information.

Response Example

{
  "status": "order_complete",
  "subtotal": 1599.98,
  "total": 1699.98,
  "salesTax": 0,
  "currency": "USD",
  "processingFee": 100,
  "createdAt": "2024-03-01T12:00:00.000Z",
  "updatedAt": "2024-03-05T15:30:00.000Z",
  "shippingLabelUrl": "https://shipping.collectpure.com/labels/12345.pdf",
  "payoutMethod": "bank_transfer",
  "lineItems": [
    {
      "id": 1001,
      "productId": "550e8400-e29b-41d4-a716-446655440000",
      "productTitle": "2006 20th Anniversary American Silver Eagle 3-Coin Set",
      "variantTitle": "Pure Qualified",
      "price": 239.99,
      "quantity": 2,
      "status": "shipped",
      "spotPremium": 144.48,
      "spotPremiumDollar": 141.83
    },
    {
      "id": 1002,
      "productId": "550e8400-e29b-41d4-a716-446655440001",
      "productTitle": "1 oz Gold Bar - PAMP Suisse",
      "variantTitle": "New",
      "price": 1120.0,
      "quantity": 1,
      "status": "shipped",
      "spotPremium": 3.5,
      "spotPremiumDollar": 37.8
    }
  ],
  "trackers": [
    {
      "status": "delivered",
      "weight": 0.5,
      "carrier": "UPS",
      "delivered": true,
      "createdAt": "2024-03-02T09:00:00.000Z",
      "lineItems": [
        {
          "id": 1001,
          "quantity": 2
        },
        {
          "id": 1002,
          "quantity": 1
        }
      ],
      "updatedAt": "2024-03-05T14:30:00.000Z",
      "totalValue": 1599.98,
      "statusDetail": "arrived_at_destination",
      "trackingCode": "1Z999AA10123456784",
      "service": "Ground",
      "containerType": "Small Box",
      "estDeliveryDate": "2024-03-05",
      "currentLocation": "Customer's address"
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

id
string
required

Order ID

Response

200
application/json

Default Response

The response is of type object.