Receive RMA Shipment

patchhttps://api.flxpoint.com/rma-shipments/{id}/receive

Use this when you want to update rma data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Request

Bodyapplication/json

array[ReceiveRmaShipmentItem]

idintegerrequired

Id of rma shipment item

rmaItemIdinteger

receivedQuantityinteger

voidedQuantityinteger

Example request

patch/rma-shipments/{id}/receive

curl -X PATCH "https://api.flxpoint.com/rma-shipments/{id}/receive" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
         {
           "id": 0,
           "rmaItemId": 0,
           "receivedQuantity": 0,
           "voidedQuantity": 0
         }
       ]'

Example body · application/json

[
  {
    "id": 0,
    "rmaItemId": 0,
    "receivedQuantity": 0,
    "voidedQuantity": 0
  }
]

Responses

204No Content

No schema documented for this status.

400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "patch": {
    "summary": "Receive RMA Shipment",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReceiveRmaShipmentItem"
            }
          }
        }
      }
    },
    "responses": {
      "204": {
        "description": "No Content"
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight