Mark Shipments as Synced to Channel

puthttps://api.flxpoint.com/shipments/mark-synced

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

Marks a collection of Shipment IDs as synced to the channel, and clears out any existing sync error. An account or channel API token may be used.

Request

Bodyapplication/json

array[integer]

array of Shipment IDs

integer

Example request

put/shipments/mark-synced

curl -X PUT "https://api.flxpoint.com/shipments/mark-synced" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
         0
       ]'

Example body · application/json

[
  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

{
  "put": {
    "summary": "Mark Shipments as Synced to Channel",
    "description": "Marks a collection of Shipment IDs as synced to the channel, and clears out any existing sync error. An account or channel API token may be used.",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "description": "array of Shipment IDs",
            "items": {
              "type": "integer"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK",
        "content": {}
      },
      "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