Order Refunds by external order id

GET 
/v2/external-order-id/:id/refunds

Shows refunds information about an existing order and its products by external order id. This endpoint allows API users to get current information on the refunds of their orders.

Request

Path Parameters

id stringrequired
ID of the order provided to Bonsai by the party who placed the order. This can be anything you like, but should be unique per order.
Example: 51cf91c1-da4a-42c4-81d3-3ec3e3268655

Responses

200

Success

application/json

Schema

Schema

data object
id stringrequired
Public ID of the order.
orderNumber floatrequired
Customer order number.
externalId string
ID of the order provided to Bonsai by the party who placed the order. This can be anything you like, but should be unique per order.
refunds object[]required
Array [
products object[]required
Array [
id stringrequired
Product ID.
variantId stringrequired
The ID of the product variant.
quantity floatrequired
Possible values: >= 1
Quantity of the product variant.
]
refundReason stringrequired
refundedAmount floatrequired
Total amount refunded across the subtotal, shipping, and taxes
breakdown objectrequired
goods floatrequired
The amount of goods refunded
goodsTax floatrequired
The amount of goods tax refunded
shipping floatrequired
The amount of shipping refunded
shippingTax floatrequired
The amount of shipping tax refunded
duties floatrequired
The amount of duties refunded
currency stringrequired
Possible values: [CAD, USD, GBP, AUD, EUR]
Currency of the refund
refundedAt stringrequired
Refund creation date and time.
]

Example (from schema)

{
  "data": {
    "id": "cldbvy7gt0006hpzo9nyw72ks",
    "orderNumber": 238636,
    "externalId": "51cf91c1-da4a-42c4-81d3-3ec3e3268655",
    "refunds": [
      {
        "products": [
          {
            "id": "clad6pg5z00eu012gfz7hfm92",
            "variantId": "M00679529706740",
            "quantity": 1
          }
        ],
        "refundReason": "string",
        "refundedAmount": 100,
        "breakdown": {
          "goods": 5,
          "goodsTax": 1,
          "shipping": 1,
          "shippingTax": 1,
          "duties": 0,
          "currency": "USD"
        },
        "refundedAt": "2023-02-06T19:44:55.460Z"
      }
    ]
  }
}

400

400 - Bad request

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 400,
      "detail": "",
      "title": "Bad input request"
    }
  ]
}

401

401 - Unauthorized

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
Unique identifier for error. Can be used for tracing across services.
status floatrequired
HTTP status code.
code stringrequired
Unique code for specific error.
title stringrequired
Short description what the error entails.
detail objectrequired
Useful details related to the error
authentication_expected string
]

Example (from schema)

{
  "errors": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "status": 401,
      "code": "AUTHENTICATION_FAILED",
      "title": "Authentication failed",
      "detail": {
        "authentication_expected": "Authorization header"
      }
    }
  ]
}

404

404 - Not found

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
Unique identifier for error. Can be used for tracing across services.
status floatrequired
HTTP status code.
code stringrequired
Unique code for specific error.
title stringrequired
Short description what the error entails.
detail objectrequired
Useful details related to the error
customer_order_id string
]

Example (from schema)

{
  "errors": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "status": 404,
      "code": "CUSTOMER_ORDER_NOT_FOUND",
      "title": "Customer order has not been found",
      "detail": {
        "customer_order_id": "cldbvy7gt0006hpzo9nyw72ks"
      }
    }
  ]
}

5XX

500 - Unknown error

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "detail": "",
      "title": "Unknown error"
    }
  ]
}

Loading...