Delete Shipment Custom Fields

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

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 custom field(s) by providing the ID(s).

A source token or account token may be used.

Request

Bodyapplication/json

Remove shipment custom fields by id

customFieldIdsarray[integer]

integer

Example request

delete/shipment/{id}/custom-fields

curl -X DELETE "https://api.flxpoint.com/shipment/{id}/custom-fields" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "customFieldIds": [
           0
         ]
       }'

Example body · application/json

{
  "customFieldIds": [
    0
  ]
}

Responses

200OK

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

{
  "delete": {
    "summary": "Delete Shipment Custom Fields",
    "description": "Delete shipment custom field(s) by providing the ID(s).\n\nA source token or account token may be used.",
    "parameters": [],
    "requestBody": {
      "description": "Remove shipment custom fields by id",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "customFieldIds": {
                "x-stoplight": {
                  "id": "01t2ey9y94751"
                },
                "type": "array",
                "items": {
                  "x-stoplight": {
                    "id": "tweo6vqgc69fq"
                  },
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK"
      },
      "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