> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SPS Commerce

> How to set up the SPS Commerce connector, plus the actions that are available.

![SPS Commerce](https://stackone-logos.com/api/sps-commerce/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/spscommerce/changelog.md)

[24 actions](#actions) · 3 auth methods

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 - Client Credentials (Machine-to-Machine) · Connector Profile](https://docs.stackone.com/connectors/spscommerce/guides/connector-profile/oauth-2-0-client-credentials-machine-to-machine.md)
>
> Connect using OAuth 2.0 Client Credentials for direct server-to-server access. Recommended when you are integrating SPS...

> [card] [OAuth 2.0 - Authorization Code (Web Service) · Connector Profile](https://docs.stackone.com/connectors/spscommerce/guides/connector-profile/oauth-2-0-authorization-code-web-service.md)
>
> Connect using OAuth 2.0 Authorization Code flow. Use this when StackOne is acting on behalf of an SPS customer (e.g., a...

> [card] [OAuth 2.0 - Authorization Code with PKCE (Native / SPA) · Connector Profile](https://docs.stackone.com/connectors/spscommerce/guides/connector-profile/oauth-2-0-authorization-code-with-pkce-native-spa.md)
>
> Connect using OAuth 2.0 Authorization Code flow with PKCE. Use this for desktop, mobile, or single-page apps that cannot...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 - Client Credentials (Machine-to-Machine) · Link Account](https://docs.stackone.com/connectors/spscommerce/guides/link-account/oauth-2-0-client-credentials-machine-to-machine.md)

> [card] [OAuth 2.0 - Authorization Code (Web Service) · Link Account](https://docs.stackone.com/connectors/spscommerce/guides/link-account/oauth-2-0-authorization-code-web-service.md)

> [card] [OAuth 2.0 - Authorization Code with PKCE (Native / SPA) · Link Account](https://docs.stackone.com/connectors/spscommerce/guides/link-account/oauth-2-0-authorization-code-with-pkce-native-spa.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0 - Authorization Code (Web Service)

OAuth 2.0 - Authorization Code with PKCE (Native / SPA)

OAuth 2.0 - Client Credentials (Machine-to-Machine)

No auth methods found

24 actions

ActionDescription

List Submission Forms`spscommerce_list_submission_forms`

List all available trading-partner submission forms (campaigns) on the SPS Commerce network.

Get Submission Form`spscommerce_get_submission_form`

Retrieve a specific trading-partner submission form by ID.

Create Trading Partner Submission`spscommerce_create_trading_partner_submission`

Submit a new trading partner (supplier or retailer) for SPS Commerce onboarding.

List Transactions`spscommerce_list_transactions`

List EDI transaction files in a directory on the SPS Commerce file space.

Get Transaction`spscommerce_get_transaction`

Download a specific EDI transaction file by its full path.

Create Transaction (Upload EDI File)`spscommerce_create_transaction`

Upload a new EDI transaction file to the SPS Commerce file space.

Delete Transaction`spscommerce_delete_transaction`

Delete an EDI transaction file from the SPS Commerce file space.

View Interaction History`spscommerce_list_transaction_history`

List file processing reports for transactions transmitted to/from SPS Commerce.

List Shipping Label Templates`spscommerce_list_shipping_labels`

List all GS1-128 / UCC-128 shipping-label templates available to the authenticated user.

Get Shipping Label Template`spscommerce_get_shipping_label`

Retrieve the details of a single shipping-label template by ID.

Get Shipping Label JSON Schema`spscommerce_get_shipping_label_schema`

Retrieve the JSON Schema (draft-07) for a shipping-label template.

Get Shipping Label Sample JSON`spscommerce_get_shipping_label_sample`

Retrieve a sample JSON payload for a shipping-label template.

Render Shipping Label Sample PDF`spscommerce_render_shipping_label_sample_pdf`

Render a sample PDF preview of a shipping label (no real data required).

Render Shipping Label PDF`spscommerce_render_shipping_label_pdf`

Render a retailer-compliant shipping label as PDF, populated with the supplied data.

Render Shipping Label PDF Batch`spscommerce_render_shipping_label_pdf_batch`

Submit an async batch job to render a large set of shipping-label PDFs.

Render Shipping Label ZPL`spscommerce_render_shipping_label_zpl`

Render a retailer-compliant shipping label as ZPL (Zebra Printer Language).

Render Shipping Label ZPL Batch`spscommerce_render_shipping_label_zpl_batch`

Submit an async batch job to render a large set of shipping labels as ZPL.

Get Shipping Label Batch Status`spscommerce_get_shipping_label_batch_status`

Poll the status of a previously-submitted PDF or ZPL batch job.

List Packing Slip Templates`spscommerce_list_packing_slips`

List all packing-slip templates available to the authenticated user.

Get Packing Slip Template`spscommerce_get_packing_slip`

Retrieve the details of a single packing-slip template by ID.

Get Packing Slip JSON Schema`spscommerce_get_packing_slip_schema`

Retrieve the JSON Schema (draft-07) for a packing-slip template.

Get Packing Slip Sample JSON`spscommerce_get_packing_slip_sample`

Retrieve a sample JSON payload for a packing-slip template.

Render Packing Slip Sample PDF`spscommerce_render_packing_slip_sample_pdf`

Render a sample PDF preview of a packing slip (no real data required).

Render Packing Slip PDF`spscommerce_render_packing_slip_pdf`

Render a retailer-compliant packing slip as PDF, populated with the supplied data.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.