Skip to main content

Get FBA Plan Options for Purchase Order

GET 

/api/purchase-orders/:purchase_order/fba-plan-options

What is needed to send a purchase order straight from the supplier to Amazon FBA.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

  • eligible: the PO is open, has a supplier, is not a dropship PO, has not been received into another warehouse, is not on a live AWD plan and is not itself a shipment PO split from another
  • on_other_network: the PO is on a live AWD plan; a PO ships to one Amazon network at a time
  • split_blocked: null, or {code, message} when the PO can't be split into per-shipment POs: po_line_invoiced (supplier invoices, vendor credits, landed costs or bills already recorded) or po_product_on_several_lines (the same product on more than one open line). Creating the plan then answers 422 with that code
  • received_elsewhere: the PO already has receipts into a warehouse that is not one of the accounts' FBA warehouses, so it can't receive into FBA
  • fba_available / instances[]: Amazon accounts with at least one active FBA warehouse (id, name, destinations[] of warehouse_id, name, country_code)
  • ship_from[]: the supplier's warehouses (default first) with address_complete and missing_fields
  • default_name: suggested plan name (≤40 characters)
  • open_lines, open_units: quantity not yet received nor on a live FBA or AWD plan for this PO. Once Amazon creates an FBA plan's shipments, each shipment's units move out of this PO into the shipment's own PO (named after the shipment confirmation id, parent_purchase_order_id = this PO) and stop counting here
  • lines[]: per product, for the dialog's preview: product_id, sku, name, ordered, received, on_plans (units on live FBA and AWD plans) and open
  • nothing_left: every line is already received or on an Amazon plan
  • existing_plans[]: FBA plans already built from this PO (id, name, status, integration_instance_id)

Token scopes: needs both the purchase-orders and integrations scopes.

Request​

Responses​

OK

Response Headers
    Content-Type