Create a refund adjustment on an order | feedonomics

curl -X POST https://api.feedamp.feedonomics.com/api/v2/orders/109872189273617283/refunds \
     -H "token: token" \
     -H "client: 1" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "cp_refund_number": "REFUND-1234",
  "refund_lines": [
    {
      "feedamp_order_line_id": "109872189273617283",
      "refund_reason": "customer_cancelled"
    }
  ]
}'

{
  "cp_refund_number": "REFUND-1234",
  "id": "109872189273617283",
  "refund_lines": [
    {
      "feedamp_order_line_id": "109872189273617283",
      "refund_reason": "customer_cancelled",
      "refund_line_number": "XX-111-FF-1111",
      "refund_quantity": 1,
      "currency": "USD",
      "item_refund": 1.99,
      "item_tax_refund": 0.19,
      "shipping_refund": 2,
      "shipping_tax_refund": 0.2,
      "discount_refund": 1,
      "refund_notes": "Courtesy refund - thank you for your business"
    }
  ]
}

Post a refund to a line item

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

order-idstringRequired

FeedAMP Order ID

Headers

tokenstringRequired

The Authentication token obtained from the v1 get_token route

clientintegerRequired

The ID of the client making the request

Request

This endpoint expects an object.

cp_refund_numberstringRequired

Seller Refund ID. Must be unique for all posted refunds.

refund_lineslist of objectsRequired

Response

Refund object

cp_refund_numberstring

Seller Refund ID. Must be unique for all posted refunds.

idstring

Unique identifier for a record

refund_lineslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error