Skip to main content

Order Refunds by id

GET 

/v2/:id/refunds

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

Request

Path Parameters

    id stringrequired

    Public ID of the order.

    Example: cldbvy7gt0006hpzo9nyw72ks

Responses

Success

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.

  • ]
Loading...