FlxpointBeta

Post Source PO Strategy

posthttps://api.flxpoint.com/sources/{sourceId}/purchase-order-strategy

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

Request

Bodyapplication/json
autoProcessboolean
maxPoNumberCharactersinteger
overridePurchaseOrderNumberStrategyIdinteger
exceedOverridePurchaseOrderNumberStrategyIdinteger
passOrderCustomFieldsToPoboolean
passOrderItemCustomFieldsToPoboolean
autoGeneratePackingSlipboolean
Always generate and attach packing slips to Fulfillment Requests created for this source
default false
attachShippingLabelsboolean
Always attach auto-purchased shipping labels to Fulfillment Requests created for this source
default true
createShipmentFromShippingLabelboolean
Automatically create a shipment after a shipping label is auto-purchased and the Fulfillment Request is processed or acknowledged. This setting does not apply to manually purchased shipping labels.
default true
maxLabelsBeforeHoldinteger
When items don't all fit in a single box, the order is automatically split across multiple boxes/labels, up to this many. If the split would need more labels than this, the order is placed On Hold instead of purchasing anything, and must be processed manually. Defaults to 1 so existing accounts see no behavior change unless they raise it.
default 1

Example request

post/sources/{sourceId}/purchase-order-strategy
curl -X POST "https://api.flxpoint.com/sources/{sourceId}/purchase-order-strategy" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "autoProcess": true,
         "maxPoNumberCharacters": 0,
         "overridePurchaseOrderNumberStrategyId": 0,
         "exceedOverridePurchaseOrderNumberStrategyId": 0,
         "passOrderCustomFieldsToPo": true,
         "passOrderItemCustomFieldsToPo": true,
         "autoGeneratePackingSlip": true,
         "attachShippingLabels": true,
         "createShipmentFromShippingLabel": true,
         "maxLabelsBeforeHold": 0
       }'
Example body · application/json
{
  "autoProcess": true,
  "maxPoNumberCharacters": 0,
  "overridePurchaseOrderNumberStrategyId": 0,
  "exceedOverridePurchaseOrderNumberStrategyId": 0,
  "passOrderCustomFieldsToPo": true,
  "passOrderItemCustomFieldsToPo": true,
  "autoGeneratePackingSlip": true,
  "attachShippingLabels": true,
  "createShipmentFromShippingLabel": true,
  "maxLabelsBeforeHold": 0
}

Responses

200OKapplication/json
idinteger
sourceIdinteger
autoProcessboolean
maxPoNumberCharactersinteger
overridePurchaseOrderNumberStrategyIdinteger
exceedOverridePurchaseOrderNumberStrategyIdinteger
passOrderCustomFieldsToPoboolean
passOrderItemCustomFieldsToPoboolean
autoGeneratePackingSlipboolean
Always generate and attach packing slips to Fulfillment Requests created for this source
default false
attachShippingLabelsboolean
Always attach auto-purchased shipping labels to Fulfillment Requests created for this source
default true
createShipmentFromShippingLabelboolean
Automatically create a shipment after a shipping label is auto-purchased and the Fulfillment Request is processed or acknowledged. This setting does not apply to manually purchased shipping labels.
default true
maxLabelsBeforeHoldinteger
When items don't all fit in a single box, the order is automatically split across multiple boxes/labels, up to this many. If the split would need more labels than this, the order is placed On Hold instead of purchasing anything, and must be processed manually. Defaults to 1 so existing accounts see no behavior change unless they raise it.
default 1
useGlobalAndSourceWorkflowStrategyboolean
packingSlipFormatstring
Specifies the default global packing slip format. Can be overridden by the 'Auto Generate Packing Slip' source setting at the source level. Accepted values: 'basic' or 'detailed'.
allowedbasicdetailed
packingSlipOptionsstring
Example response
{
  "id": 0,
  "sourceId": 0,
  "autoProcess": true,
  "maxPoNumberCharacters": 0,
  "overridePurchaseOrderNumberStrategyId": 0,
  "exceedOverridePurchaseOrderNumberStrategyId": 0,
  "passOrderCustomFieldsToPo": true,
  "passOrderItemCustomFieldsToPo": true,
  "autoGeneratePackingSlip": true,
  "attachShippingLabels": true,
  "createShipmentFromShippingLabel": true,
  "maxLabelsBeforeHold": 0,
  "useGlobalAndSourceWorkflowStrategy": true,
  "packingSlipFormat": "basic",
  "packingSlipOptions": "string"
}
401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment
{
  "post": {
    "summary": "Post Source PO Strategy",
    "description": "",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SaveSourcePurchaseOrderStrategyRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SourcePurchaseOrderStrategy"
            }
          }
        }
      },
      "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
Was this page helpful?
Can't find what you need?