Skip to main content

Update SPS Commerce Settings

PATCH 
/api/spscommerce/integrations/:id/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.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token and the integrations.update permission.

Fields: name, receiver_id, sender_id (null to clear), is_auto_polling_enabled, send_invoices (when true, an 810 invoice is sent to the trading partner for each shipment after its 856 advance ship notice is sent, billing the shipped quantities at the purchase order price; defaults to false), send_inventory_advice (when true, each trading partner is sent a daily 846 inventory advice with the available quantity of every item it has ordered; defaults to false), pack_level_asn (when true, each 856 reports the shipment carton by carton with an SSCC-18 per carton; requires gs1_company_prefix), gs1_company_prefix (7–10 digit GS1 company prefix the SSCC-18 numbers are built from; required when pack_level_asn is true), sscc_extension_digit (0–9, default 0), carton_label_ids (object mapping each trading partner ID to the SPS label template used to render its carton labels).

  • inventory_advice_warehouse_ids (array of integers, optional): warehouses whose available stock the daily 846 counts; an empty array counts available-to-sell across every warehouse
  • inventory_advice_buffer (integer, optional, min 0): units held back from every item's 846 quantity

Request​

Responses​

OK

Response Headers
    Content-Type