SPS Commerce
List SPS Commerce Integrations
List SPS Commerce connections for this account. Credentials and tokens are never returned.
Initialize SPS Commerce OAuth Flow
Initialize the SPS Commerce OAuth 2.0 authorization flow.
Complete SPS Commerce Integration Setup
Finish connecting after the SPS Commerce consent screen redirected back: exchanges the authorization code, stores the token, creates the connection and its sales channel.
Test SPS Commerce Connection
Test the connection to SPS Commerce Transaction API.
Update SPS Commerce Settings
Update a connection's name, trading-partner IDs, automatic polling, EDI invoicing, inventory advice and carton-level ship notices. Send only the fields you change.
Delete SPS Commerce Integration
Disconnect SPS Commerce: removes the connection and its EDI documents. Refused once the connection has created sales orders.
List Carton Label Templates
List the carton label templates SPS Commerce can render for the account, and the trading partners (from received purchase orders) to choose a template for, with each partner's current choice. Choices are saved with carton_label_ids on Update SPS Commerce Settings.
Get Shipment Packing
Get a shipment's carton packing: what shipped versus what is packed, the cartons with their SSCC-18 numbers and label status, the freight references, and the ship notice (856) status (not_shipped, waiting_for_packing, ready, sent, failed). A connection that sends carton-level ship notices holds a shipped order's 856 until its packing is finalized.
Update Shipment Packing
Replace the shipment's cartons. Partial packing may be saved; packing more of a line than shipped, or an empty carton, is refused with 422. Refused once packing is finalized (reopen first) or once the 856 has been sent.
Auto-Pack Shipment
Build and save a packing plan automatically. mode=case_pack fills full cartons of each product's case quantity, puts each remainder in its own carton and products with no case quantity in one shared carton; mode=single_carton packs everything into one carton. Carton weights are estimated from product weights. Returns the new packing and any warnings.
Update Shipment Freight Details
Save the shipment's freight references, which retail carton labels and the 856 header carry: bill_of_lading_number (max 30), carrier_pro_number (max 35), carrier_scac (2–4 letters, stored upper case), carrier_name (max 60). The carrier defaults to the shipment's shipping method when not set. Editable until the 856 is sent.
Finalize Shipment Packing
Lock the packing in and issue every carton its SSCC-18 number, from the connection's GS1 company prefix. Requires every shipped unit to be packed. If the shipment has already shipped, its held 856 ship notice (and 810 invoice, when enabled) is sent.
Reopen Shipment Packing
Reopen finalized packing for changes. The cartons' SSCC numbers and labels are voided; new numbers are issued on the next finalize, so printed labels must be replaced. Refused once the 856 has been sent.
Generate Carton Labels
Render every finalized carton's retailer-formatted GS1-128 label through SPS Commerce, using the label template chosen for the trading partner, and store the ZPL per carton. When the retailer's template needs data the shipment lacks, returns 422 naming what to add (for example a bill of lading number or a shorter carrier name).
Download Carton Labels (ZPL)
Download every stored carton label as one ZPL file for a thermal printer (Content-Type application/zpl). Returns 422 until labels have been generated.
Download Carton Labels (PDF)
Render every carton label as one PDF through SPS Commerce, for printing on an ordinary printer (Content-Type application/pdf).
List EDI Documents
Paginated list of every EDI document the connection received or sent, newest first. Each row names the purchase order it belongs to, its sales order and shipment (when it has one), the trading partner, its send status and the reason it failed.
Download EDI Document XML
Download the document exactly as it was exchanged with SPS Commerce, as an XML file attachment.
Resend EDI Document
Queue another attempt at an outbound document (acknowledgment, ship notice, invoice or inventory advice) that failed to send. The document goes back to ready and its previous error is cleared.
List Item Mappings
Paginated item mappings of the connection.
Create Item Mapping
Match a trading partner item number to a product. Every failed purchase order waiting on that item number is retried straight away; retried_purchase_orders says how many.
List Unmatched Items
Item numbers on purchase orders that have not become sales orders because no product matches them, one row per item number, with how many purchase orders and units are waiting. Item numbers that already have an active mapping are left out.
Update Item Mapping
Change a mapping's item number, product, description or active flag. When the mapping is active, failed purchase orders waiting on its item number are retried.
Delete Item Mapping
Delete a mapping. New purchase orders with that item number fail until it matches a product again; sales orders already created are unchanged.
List Purchase Orders
List EDI 850 purchase orders received for an SPS Commerce integration, paginated.
Delete Purchase Orders
Permanently delete multiple purchase orders.
Get Purchase Order
Get detailed information for a specific purchase order including line items.
Retry Purchase Order Conversion
Re-run conversion of a purchase order that failed (for example after mapping its SKUs). Queued; the existing purchase order is converted rather than duplicated.
Map Buyer SKU to Product
Map a trading partner's buyer part number to one of your products. The mapping is remembered for future purchase orders on this connection, applied straight away to unmapped lines of purchase orders already received (those not yet converted to sales orders), and any failed purchase order left with no unmapped lines is queued to create its sales order.
Poll for New Purchase Orders
Manually trigger polling for new EDI 850 purchase orders from SPS Commerce.
Send Acknowledgment (855)
Send EDI 855 PO Acknowledgment to SPS Commerce for one or more purchase orders.
Download Raw XML
Download the raw EDI 850 XML for a purchase order.
Export Purchase Orders
Export purchase orders to CSV or Excel.
Archive Purchase Orders
Archive multiple purchase orders.
Unarchive Purchase Orders
Unarchive multiple purchase orders.
Get Purchase Order Statistics
Get statistics and metrics for purchase orders.
List Acknowledgments
Get paginated list of EDI 855 PO Acknowledgments sent to trading partners.
Get Acknowledgment
Get detailed information for a specific 855 acknowledgment.
Download Acknowledgment XML
Download the raw EDI 855 XML that was sent to SPS Commerce.
Get Acknowledgment Statistics
Get statistics for 855 acknowledgments.
Send ASN
Generate (if needed) and send the 856 Advance Ship Notice for a completed fulfillment of an order received through this SPS Commerce integration. Retries resume the existing ASN; an ASN already sent is not transmitted again.
List ASN
Get paginated list of EDI 856 Advance Ship Notices sent to trading partners.
Get ASN
Get detailed information for a specific 856 ASN.
Download ASN XML
Download the raw EDI 856 XML that was sent to SPS Commerce.
Get Ship Notice Statistics
Get statistics for 856 ASN documents.