Flag Shipments with Sync Errors

puthttps://api.flxpoint.com/shipments/flag-with-errors

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.

Takes a collection of shipments, and saves their errors encountered when syncing to the channel.

Request

Bodyapplication/json

array[Shipment]

array of shipments with errors

idinteger

notestring

trackingUrlstring

trackingNumberstring

carrierstring

methodstring

shippedAtstring (date-time)

insertedAtstring (date-time)

shippingCostnumber

orderIdinteger

purchaseOrderIdinteger

fulfillmentRequestIdinteger

rmaIdinteger

sourceIdinteger

accountIdinteger

partialboolean

suppressedboolean

syncedToChannelboolean

syncErrorstring

crossDockPurchaseOrderIdinteger

shipmentItemsarray[ShipmentItem]

idinteger

skustring

quantityinteger

shipmentIdinteger

inventoryVariantIdinteger (int64)

partialboolean

orderItemIdinteger

purchaseOrderItemIdinteger

this field will soon be deprecated, please start using `fulfillmentRequestItemId` instead. there are basically the same thing, just there has been a terminology change.

fulfillmentRequestItemIdinteger

committedStockReleasedQuantityinteger

rmaItemIdinteger

customFieldsarray[ShipmentCustomField]

idinteger

namestring

valuestring

customFieldsarray[ShipmentCustomField]

idinteger

namestring

valuestring

updatedAtstring (date-time)

accountingSyncedboolean

Example request

put/shipments/flag-with-errors

curl -X PUT "https://api.flxpoint.com/shipments/flag-with-errors" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
         {
           "id": 0,
           "note": "string",
           "trackingUrl": "string",
           "trackingNumber": "string",
           "carrier": "string",
           "method": "string",
           "shippedAt": "2026-04-20T00:00:00Z",
           "insertedAt": "2026-04-20T00:00:00Z",
           "shippingCost": 0,
           "orderId": 0,
           "purchaseOrderId": 0,
           "fulfillmentRequestId": 0,
           "rmaId": 0,
           "sourceId": 0,
           "accountId": 0,
           "partial": true,
           "suppressed": true,
           "syncedToChannel": true,
           "syncError": "string",
           "crossDockPurchaseOrderId": 0,
           "shipmentItems": [
             {
               "id": 0,
               "sku": "string",
               "quantity": 0,
               "shipmentId": 0,
               "inventoryVariantId": 0,
               "partial": true,
               "orderItemId": 0,
               "purchaseOrderItemId": 0,
               "fulfillmentRequestItemId": 0,
               "committedStockReleasedQuantity": 0,
               "rmaItemId": 0,
               "customFields": [
                 null
               ]
             }
           ],
           "customFields": [
             {
               "id": 0,
               "name": "string",
               "value": "string"
             }
           ],
           "updatedAt": "2026-04-20T00:00:00Z",
           "accountingSynced": true
         }
       ]'

Example body · application/json

[
  {
    "id": 0,
    "note": "string",
    "trackingUrl": "string",
    "trackingNumber": "string",
    "carrier": "string",
    "method": "string",
    "shippedAt": "2026-04-20T00:00:00Z",
    "insertedAt": "2026-04-20T00:00:00Z",
    "shippingCost": 0,
    "orderId": 0,
    "purchaseOrderId": 0,
    "fulfillmentRequestId": 0,
    "rmaId": 0,
    "sourceId": 0,
    "accountId": 0,
    "partial": true,
    "suppressed": true,
    "syncedToChannel": true,
    "syncError": "string",
    "crossDockPurchaseOrderId": 0,
    "shipmentItems": [
      {
        "id": 0,
        "sku": "string",
        "quantity": 0,
        "shipmentId": 0,
        "inventoryVariantId": 0,
        "partial": true,
        "orderItemId": 0,
        "purchaseOrderItemId": 0,
        "fulfillmentRequestItemId": 0,
        "committedStockReleasedQuantity": 0,
        "rmaItemId": 0,
        "customFields": [
          null
        ]
      }
    ],
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "updatedAt": "2026-04-20T00:00:00Z",
    "accountingSynced": true
  }
]

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": "Flag Shipments with Sync Errors",
    "description": "Takes a collection of shipments, and saves their errors encountered when syncing to the channel.",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "description": "array of shipments with errors",
            "items": {
              "$ref": "#/components/schemas/Shipment"
            }
          }
        }
      }
    },
    "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