API overview
Read one owned CreditNote resource
Choose an operation to see its request, response shape, access rules and implementation source.
ReadAuthenticated
GET/api/v1/credit-notes/{creditNote}
Read one owned CreditNote resource
Sanctum session or bearer token. Required bearer ability: credit_notes.read
Request
| Field | In | Rule |
|---|---|---|
creditNote | Path parameter | Required numeric ID owned by the authenticated customer. Foreign and missing IDs return 404. |
No request body.
curl --request GET "https://shop.example.test/api/v1/credit-notes/$CREDIT_NOTE_ID" \
--header 'Accept: application/json' \
--header "Authorization: Bearer $API_TOKEN"Response200
Success: 200
Response shape (notation, not a captured response)
{ data: CreditNote }Common errors
| HTTP status | Meaning |
|---|---|
401 | unauthenticated: missing or invalid authentication. |
403 | unauthorized, insufficient_scope or ip_not_allowed: check account context, required ability and token IP policy. |
404 | not_found: missing, inactive or foreign-owned resource. |
429 | rate_limited: back off before retrying, especially writes. |