Stock Hub
POST https://reseller.server.com/api/v1/stockhub/rma

The rma webhook performs a POST in JSON format to a designated endpoint of the reseller.

Headers

  • x-version string Required

    Version of the webhook.

  • x-api-key string

    The API-key is a shared secret that can be used to authenticate the incomming request.

application/json

Body

  • increment_id string
  • order_increment_id string
  • date_requested string(date-time)
  • items array[object]
    Hide items attributes Show items attributes object
    • id integer
    • resolution string
    • reason string | null
    • qty_requested integer
    • qty_approved integer | null
    • qty_returned integer | null
    • manufacturer string | null
    • color string | null
    • size string | null
    • mpn string | null
    • merchant_product_reference string | null
    • merchant_resolution string | null
    • sku string
    • parent_sku string | null
    • item_return_fee number(float)
    • row_line_return_fee number(float)
    • status string

      Status of an RMA item. Value is either one of the following: 'pending', 'authorized', 'partially_authorized', 'received', 'received_on_item', 'approved', 'approved_on_item', 'rejected', 'rejected_on_item','denied', 'closed', 'processed_closed'

  • status string
  • track object | null
    Hide track attributes Show track attributes object | null
    • tracking_number string
    • carrier string
    • method string | null
    • tracking_url string | null
  • date_received string | null
  • date_processed string | null
  • currency string
  • po_number string

    The PO (Purchase order) number is the reference number to pay for approved purchases. The PO number is used to link the RMA to the order of the purchasing company.

Responses

  • 200

    Ok

  • 202

    Accepted

  • 406

    Not accepted

POST winkelstraat/stock-hub/v1/rma
Request examples 
# Headers
x-version: V1
x-api-key: string

# Payload
{
  "increment_id": "000000093",
  "order_increment_id": "000000549",
  "date_requested": "2024-03-08T13:25:19.000+00:00",
  "items": [
    {
      "id": 90,
      "resolution": "refund",
      "reason": "no_reason",
      "qty_requested": 1,
      "qty_approved": null,
      "qty_returned": null,
      "manufacturer": "Emporio Armani",
      "color": "Blauw",
      "size": "S",
      "mpn": "3G1MXE1MXVZF982",
      "merchant_product_reference": "3G1MXE1MXVZF982",
      "merchant_resolution": null,
      "parent_sku": "381189",
      "item_return_fee": 2.95,
      "row_line_return_fee": 2.95,
      "sku": "wsnl199-5c9de5ad4681ed3eb551e7ee",
      "status": "authorized"
    }
  ],
  "status": "authorized",
  "track": {
    "tracking_number": "1Z97W143680086AAP",
    "carrier": "ups",
    "method": null,
    "tracking_url": "https://wwwapps.ups.com/WebTracking/processInputRequest?loc=nl_NL&tracknum=1Z97W1436800867AAP"
  },
  "date_received": null,
  "date_processed": null,
  "currency": "EUR",
  "po_number": "YOUR_ORDER_REFERENCE"
}