Skip to main content
SPS Commerce
Betav1.0.0
24 actions · 3 auth methods
CRMDocuments

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0 - Client Credentials (Machine-to-Machine)

Connect using OAuth 2.0 Client Credentials for direct server-to-server access. Recommended when you are integrating SPS…

Connector Profile · OAuth 2.0 - Authorization Code (Web Service)

Connect using OAuth 2.0 Authorization Code flow. Use this when StackOne is acting on behalf of an SPS customer (e.g., a…

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

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0 - Client Credentials (Machine-to-Machine)

Link Account · OAuth 2.0 - Authorization Code (Web Service)

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

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
24 actions
Action
Description
List Submission Forms
List all available trading-partner submission forms (campaigns) on the SPS Commerce network.
Get Submission Form
Retrieve a specific trading-partner submission form by ID.
Create Trading Partner Submission
Submit a new trading partner (supplier or retailer) for SPS Commerce onboarding.
List Transactions
List EDI transaction files in a directory on the SPS Commerce file space.
Get Transaction
Download a specific EDI transaction file by its full path.
Create Transaction (Upload EDI File)
Upload a new EDI transaction file to the SPS Commerce file space.
Delete Transaction
Delete an EDI transaction file from the SPS Commerce file space.
View Interaction History
List file processing reports for transactions transmitted to/from SPS Commerce.
List Shipping Label Templates
List all GS1-128 / UCC-128 shipping-label templates available to the authenticated user.
Get Shipping Label Template
Retrieve the details of a single shipping-label template by ID.
Get Shipping Label JSON Schema
Retrieve the JSON Schema (draft-07) for a shipping-label template.
Get Shipping Label Sample JSON
Retrieve a sample JSON payload for a shipping-label template.
Render Shipping Label Sample PDF
Render a sample PDF preview of a shipping label (no real data required).
Render Shipping Label PDF
Render a retailer-compliant shipping label as PDF, populated with the supplied data.
Render Shipping Label PDF Batch
Submit an async batch job to render a large set of shipping-label PDFs.
Render Shipping Label ZPL
Render a retailer-compliant shipping label as ZPL (Zebra Printer Language).
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
Poll the status of a previously-submitted PDF or ZPL batch job.
List Packing Slip Templates
List all packing-slip templates available to the authenticated user.
Get Packing Slip Template
Retrieve the details of a single packing-slip template by ID.
Get Packing Slip JSON Schema
Retrieve the JSON Schema (draft-07) for a packing-slip template.
Get Packing Slip Sample JSON
Retrieve a sample JSON payload for a packing-slip template.
Render Packing Slip Sample PDF
Render a sample PDF preview of a packing slip (no real data required).
Render Packing Slip PDF
Render a retailer-compliant packing slip as PDF, populated with the supplied data.