Schema Information for SPS Commerce
Learn about the schema information for SPS Commerce to understand its structure and design better.
Schema Information for SPS Commerce
Learn about the schema information for SPS Commerce to understand its structure and design better.
In this article, we will look at the schema information of the supported APIs and tables for SPS Commerce.
Find the links to other articles related to SPS Commerce below:
Tables/APIs Supported
The tables and APIs associated with the SPS Commerce connector are as follows.
Shipping Labels
Purpose: The Shipping Labels API in SPS Commerce plays a vital role in automating and managing the generation and retrieval of shipping labels for retail and e-commerce operations. It ensures compliance with trading partner requirements and supports accurate, timely label creation for outbound shipments. This API is especially valuable for streamlining logistics, reducing manual errors, and ensuring that shipments meet routing and labeling standards across various retailer networks.
Source API Documentation: https://developercenter.spscommerce.com/#/docs/shipping-doc-api/labels/get_all_labels
Replication Type: OAuth
| Field Name | Data Type |
|---|---|
| id | String |
| ownerID | String |
| ownerName | String |
| canRender | Boolean |
| type | String |
| name | String |
| description | String |
Shipping Label By ID
Purpose: The Shipping Labels by ID API in SPS Commerce serves as a vital endpoint for retrieving detailed shipping label information associated with specific shipments. It enables precise access to carrier label data, tracking numbers, and shipping documentation necessary for order fulfillment and logistics coordination. This API is particularly useful for verifying shipment details, facilitating label reprinting, ensuring compliance with retailer-specific requirements, and resolving discrepancies in the outbound shipping process.
Source API Documentation:
Replication Type: OAuth
| Field Name | Data Type |
|---|---|
| id | String |
| ownerID | String |
| ownerName | String |
| canRender | Boolean |
| type | String |
| name | String |
| description | String |
| format | String |
| outputFormat | String |
| createdAt | String (Datetime) |
| versions.version | String |
| versions.versionNotes | String |
| versions.tags | Array of Strings |
| versions.createdAt | String (Datetime) |
| aliases.version | String |
| aliases.alias | String |
| status | String |
Shipping Label By Sample
Purpose: The Shipping Labels by Sample API in SPS Commerce is a key resource for generating and retrieving compliant shipping labels based on pre-configured trading partner requirements. This API streamlines the label creation process by providing standardized label formats, carrier details, and shipment identifiers. It plays a vital role in ensuring accurate labeling, efficient warehouse operations, and seamless compliance with retail partners’ logistics specifications—making it essential for optimizing outbound shipment workflows in a retail supply chain.
Source API Documentation:
Replication Type: OAuth
| Field Name | Data Type |
|---|---|
| Address.Address1 | String |
| Address.Address2 | String |
| Address.AddressName | String |
| Address.AddressTypeCode | String |
| Address.AddressLocationNumber | String |
| Address.City | String |
| Address.Country | String |
| Address.PostalCode | String |
| Address.State | String |
| BillOfLadingNumber | String |
| CarrierRouting | String |
| CarrierProNumber | String |
| PurchaseOrderNumber | String |
| ShippingSerialID | String |
| Item.UPCCaseCode | String |
| Item.VendorPartNumber | String |