Docs
Management API
Orders
Order Fees

Order Fees

Get Fees

GET /orders/{order_id}/fees

Request

Get all fees for an order.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • order_id in path - integer
    required
    ID of the order.

example

Response

OK

Body

object | application/json

  • id    integer

    The unique numeric identifier of the fees object.
    Example: 1

  • type    string

    The type of the fee.

    Allowed: custom_fee

  • display_name_customer    string

    The display name of the fee targeting customers.
    Example: Package Protection Insurance

  • display_name_merchant    string

    The display name of the fee targeting shoppers.
    Example: Package Protection Fee

  • source    string

    The source of the request.
    Example: v2

  • base_cost

    The base fee cost value. (Float, Float-As-String, Integer)
    One of:
    Type: string
    Example: 8.5

  • cost_ex_tax

    The fee cost value excluding tax. (Float, Float-As-String, Integer)
    One of:
    Type: string
    Example: 8.5

  • cost_inc_tax

    The fee cost value including tax. (Float, Float-As-String, Integer)
    One of:
    Type: string
    Example: 10

  • cost_tax

    The tax amount on the fee cost. (Float, Float-As-String, Integer)
    One of:
    Type: string
    Example: 1.5

  • tax_class_id    integer or null

    A unique numeric identifier for the tax class. If not persisted or null, the default fee tax class from the control panel is used.

response

Did you find what you were looking for?
List Order CouponsGet Fees