FlxpointAPI Help CenterBeta

Delete Shipment Item

deletehttps://api.flxpoint.com/shipment/{id}/shipment-item

Use this when you want to delete shipment 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.

Delete Shipment Item(s) by providing the ID(s).

A source token or account token may be used.

Request

Bodyapplication/json
shipmentItemIdsarray[integer]
integer

Example request

delete/shipment/{id}/shipment-item
curl -X DELETE "https://api.flxpoint.com/shipment/{id}/shipment-item" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "shipmentItemIds": [
           0
         ]
       }'
Example body ยท application/json
{
  "shipmentItemIds": [
    0
  ]
}

Responses

200OK

No schema documented for this status.

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment
{
  "delete": {
    "summary": "Delete Shipment Item",
    "description": "Delete Shipment Item(s) by providing the ID(s).\n\nA source token or account token may be used.",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "shipmentItemIds": {
                "x-stoplight": {
                  "id": "na8nu9x3la8wr"
                },
                "type": "array",
                "items": {
                  "x-stoplight": {
                    "id": "kw8vustnus7o0"
                  },
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK"
      },
      "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