Skip to main content
POST
/
public
/
{user_id}
/
orders
/
{publicOrder}
/
credits
/
apply
Apply Credits To Order
curl --request POST \
  --url https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 63
}'
{
  "data": {
    "uuid": "6ef85076-4519-3e5b-8402-b642a4bebe76",
    "status": "draft",
    "placed_at": "2025-11-21T07:55:20.0000000+00:00",
    "expires_at": "2026-03-11T14:05:31.0000000+00:00",
    "sub_total": {
      "currency": "USD",
      "amount": "9187.00",
      "amount_minor": 918700
    },
    "discount_total": {
      "currency": "USD",
      "amount": "0.00",
      "amount_minor": 0
    },
    "tax_total": {
      "currency": "USD",
      "amount": "0.00",
      "amount_minor": 0
    },
    "credits_total": {
      "currency": "USD",
      "amount": "0.00",
      "amount_minor": 0
    },
    "total": {
      "currency": "USD",
      "amount": "9187.00",
      "amount_minor": 918700
    },
    "remaining_total": {
      "currency": "USD",
      "amount": "9187.00",
      "amount_minor": 918700
    },
    "total_before_tax": {
      "currency": "USD",
      "amount": "9187.00",
      "amount_minor": 918700
    },
    "tax_breakdown": [
      {
        "amount": {
          "currency": "USD",
          "amount": "0.00",
          "amount_minor": 0
        },
        "code": "Test Tax",
        "name": "some-tax",
        "rate": 10,
        "calculator_type": "percent"
      }
    ],
    "discount_breakdown": [
      {
        "amount": {
          "currency": "USD",
          "amount": "0.00",
          "amount_minor": 0
        },
        "code": "Test Discount",
        "name": "some-discount",
        "rate": 10,
        "calculator_type": "percent"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user_id
string
required

The ID of the user.

publicOrder
string
required

Body

application/json
amount
number

Must be at least 0.

Example:

63

Response

200 - application/json
data
object