Sync Accounting for Order

patchhttps://api.flxpoint.com/orders/{id}/accounting-sync

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

Update order as synced to external accounting system

Request

Bodyapplication/json

accountingSyncedboolean | null

specify whether accounting was synced

externalAccountingIdstring | null

identfier in the external system that identifies with this order.

itemsarray[OrderItemAccountingSyncRequest]

idintegerrequired

id of order item

externalAccountingIdstring | null

identfier in the external sytem that identifies with this order item

orderItemAccountingItemsarray[OrderItemAccountingItem]

externalAccountingIdstring

identfier in the external sytem that identifies with this order item supplier sku

quantityinteger

accountingSyncErrorstring

Example request

patch/orders/{id}/accounting-sync

curl -X PATCH "https://api.flxpoint.com/orders/{id}/accounting-sync" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "accountingSynced": true,
         "externalAccountingId": "string",
         "items": [
           {
             "id": 0,
             "externalAccountingId": "string",
             "orderItemAccountingItems": [
               {
                 "externalAccountingId": null,
                 "quantity": null
               }
             ]
           }
         ],
         "accountingSyncError": "string"
       }'

Example body · application/json

{
  "accountingSynced": true,
  "externalAccountingId": "string",
  "items": [
    {
      "id": 0,
      "externalAccountingId": "string",
      "orderItemAccountingItems": [
        {
          "externalAccountingId": null,
          "quantity": null
        }
      ]
    }
  ],
  "accountingSyncError": "string"
}

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": "Sync Accounting for Order",
    "description": "Update order as synced to external accounting system",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrderAccountingSyncRequest"
          }
        }
      }
    },
    "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