Skip to main content

supplyPushShipments

Pushes one or more supply shipments to an ERP integration as inbound receiving documents.

Authentication Requirements​

Requires the supply:push_to_accounting permission for the company.

Business Rules​

  • Between one and 50 shipments per request
  • Each shipment must belong to the authenticated company and have at least one line
  • A shipment that is archived, closed or cancelled cannot be pushed
  • Each shipment line must trace to a purchase order line already pushed to the same integration, because the receiving document is written against that line
  • The integration must declare that it can accept shipments

Behavior​

Returns a process ID immediately; the push runs in the background and reports per-shipment outcomes through process_status_updates. A shipment already present in the target system is updated rather than duplicated.

supplyPushShipments(
  input: SupplyPushShipmentsInput!
): AsynchronousActionResponse!

Arguments​

supplyPushShipments.input ● SupplyPushShipmentsInput! non-null input common​

Parameters for SupplyPushShipments

Type​

AsynchronousActionResponse object common​

Asynchronous action response type