Getting Started
All endpoints below are live PromoStandards-compliant SOAP services hosted on promostandards.scrubauthority.com. To integrate:
- Contact us to request API credentials (username & password).
- Include your credentials in every SOAP request body as
wsIdandwsPassword. - Each endpoint URL serves triple duty: SOAP POST target, self-documenting GET page, and WSDL source (
?wsdl). - All services support both the version listed and earlier versions where noted.
Product Data Service
Operations & Documentation
Retrieves full product data for a given product ID, including descriptions, colors, sizes, and attributes. The primary operation for syncing product catalogs.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version (e.g. 2.0.0) |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| localizationCountry | string | Required | ISO 3166 country code (e.g. US) |
| localizationLanguage | string | Required | ISO 639‑1 language code (e.g. en) |
| productId | string | Required | Supplier product ID / SKU |
| partId | string | Optional | Specific part/variant ID |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.promostandards.org/wsdl/ProductDataService/2.0.0/"> <soapenv:Header/> <soapenv:Body> <ns:GetProductRequest> <ns:wsVersion>2.0.0</ns:wsVersion> <ns:id>YOUR_USERNAME</ns:id> <ns:password>YOUR_PASSWORD</ns:password> <ns:localizationCountry>US</ns:localizationCountry> <ns:localizationLanguage>en</ns:localizationLanguage> <ns:productId>SA101</ns:productId> </ns:GetProductRequest> </soapenv:Body> </soapenv:Envelope>
Returns the list of sellable products (or sellable parts for a given product). Use this to discover the full catalog or check if a specific product is available for sale.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Optional | Filter to a specific product ID; omit for full catalog |
| partId | string | Optional | Filter to a specific part/variant |
| isSellable | boolean | Optional | Filter by sellable status |
Returns products or parts that have been marked as close-out or discontinued. Use this to remove end-of-life items from distributor catalogs.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
Returns the IDs of products (and optionally parts) that have been modified after a specified date/time. Use for incremental catalog sync to avoid pulling the full catalog on every run.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| changeTimeStamp | dateTime | Required | ISO 8601 datetime — returns products modified after this value |
<ns:GetProductDateModifiedRequest> <ns:wsVersion>2.0.0</ns:wsVersion> <ns:id>YOUR_USERNAME</ns:id> <ns:password>YOUR_PASSWORD</ns:password> <ns:changeTimeStamp>2024-01-01T00:00:00</ns:changeTimeStamp> </ns:GetProductDateModifiedRequest>
Inventory Service
Operations & Documentation
Returns current inventory levels for a product. Response includes quantity on hand, quantity available, and future inventory data broken down by part, color, and size.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version (e.g. 2.0.0) |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Required | Supplier product ID |
| Filter | complex | Optional | Optional filter array of part/color/size values (see GetFilterValues) |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.promostandards.org/wsdl/Inventory/2.0.0/"> <soapenv:Header/> <soapenv:Body> <ns:GetInventoryLevelsRequest> <ns:wsVersion>2.0.0</ns:wsVersion> <ns:id>YOUR_USERNAME</ns:id> <ns:password>YOUR_PASSWORD</ns:password> <ns:productId>SA101</ns:productId> </ns:GetInventoryLevelsRequest> </soapenv:Body> </soapenv:Envelope>
Returns the valid filter values (colors, sizes, part IDs) that can be passed to GetInventoryLevelsRequest. Call this first to know what filter combinations are supported for a given product.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Required | Supplier product ID |
Product Pricing & Configuration Service
Operations & Documentation
Returns the decoration locations available on a product (e.g. Left Chest, Back, Sleeve). Start here before calling GetConfigurationAndPricing.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version (e.g. 1.0.0) |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Required | Supplier product ID |
| localizationCountry | string | Required | ISO 3166 country code |
| localizationLanguage | string | Required | ISO 639‑1 language code |
The core pricing operation. Returns full configuration options and pricing for a product at a given decoration location, including quantity price breaks, decoration methods, and available sizes.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Required | Supplier product ID |
| partId | string | Optional | Specific part/variant |
| currency | string | Required | ISO 4217 currency code (e.g. USD) |
| fobId | string | Optional | Specific FOB point ID |
| priceType | string | Optional | Net or List |
| localizationCountry | string | Required | ISO 3166 country code |
| localizationLanguage | string | Required | ISO 639‑1 language code |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.promostandards.org/wsdl/PricingAndConfiguration/1.0.0/"> <soapenv:Header/> <soapenv:Body> <ns:GetConfigurationAndPricingRequest> <ns:wsVersion>1.0.0</ns:wsVersion> <ns:id>YOUR_USERNAME</ns:id> <ns:password>YOUR_PASSWORD</ns:password> <ns:productId>SA101</ns:productId> <ns:currency>USD</ns:currency> <ns:localizationCountry>US</ns:localizationCountry> <ns:localizationLanguage>en</ns:localizationLanguage> </ns:GetConfigurationAndPricingRequest> </soapenv:Body> </soapenv:Envelope>
Returns additional charges associated with decorating a product — such as setup fees, run charges, or digitizing fees — for a given location and decoration method.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Required | Supplier product ID |
| localizationCountry | string | Required | ISO 3166 country code |
| localizationLanguage | string | Required | ISO 639‑1 language code |
Returns the available FOB (Freight on Board) shipping origin points. Use returned FOB IDs when calling GetConfigurationAndPricingRequest.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Required | Supplier product ID |
Returns the available decoration ink/thread colors for a specific decoration location and method on a product.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| productId | string | Required | Supplier product ID |
| locationId | string | Required | Decoration location ID (from GetAvailableLocations) |
| decorationId | string | Required | Decoration method ID |
| localizationCountry | string | Required | ISO 3166 country code |
| localizationLanguage | string | Required | ISO 639‑1 language code |
Media Content Service
Operations & Documentation
Returns product images and other media assets (URLs, MIME types, dimensions, color associations). Supports filtering by media type and class to retrieve only what you need.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version (e.g. 1.1.0) |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| cultureName | string | Optional | Culture/locale (e.g. en-US) |
| mediaType | string | Optional | Image, Video, Audio, Document |
| productId | string | Required | Supplier product ID |
| partId | string | Optional | Filter to a specific part/color variant |
| ClassType | integer | Optional | 1=Primary, 2=Alternate, 3=Lifestyle, 4=Thumbnail |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.promostandards.org/wsdl/MediaService/1.1.0/"> <soapenv:Header/> <soapenv:Body> <ns:GetMediaContentRequest> <ns:wsVersion>1.1.0</ns:wsVersion> <ns:id>YOUR_USERNAME</ns:id> <ns:password>YOUR_PASSWORD</ns:password> <ns:productId>SA101</ns:productId> <ns:mediaType>Image</ns:mediaType> </ns:GetMediaContentRequest> </soapenv:Body> </soapenv:Envelope>
Returns a list of product IDs whose media has changed after a given timestamp. Use for incremental image sync — only re-fetch products with updated assets.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| changeTimeStamp | dateTime | Required | ISO 8601 datetime — returns products with media modified after this value |
Order Status Service
Operations & Documentation
Returns the current status of one or more orders. Query by purchase order number, supplier order number, or a date range. Response includes line-level status and expected ship dates.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version (e.g. 2.0.0) |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| queryType | integer | Required | 1=PO Number, 2=Supplier Order #, 3=Date Range |
| referenceNumber | string | Optional | PO or order number (required for queryType 1 or 2) |
| statusTimeStamp | dateTime | Optional | Start of date range (required for queryType 3) |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.promostandards.org/wsdl/OrderStatusService/2.0.0/"> <soapenv:Header/> <soapenv:Body> <ns:GetOrderStatusRequest> <ns:wsVersion>2.0.0</ns:wsVersion> <ns:id>YOUR_USERNAME</ns:id> <ns:password>YOUR_PASSWORD</ns:password> <ns:queryType>1</ns:queryType> <ns:referenceNumber>PO-12345</ns:referenceNumber> </ns:GetOrderStatusRequest> </soapenv:Body> </soapenv:Envelope>
Returns the query types (methods) supported by this supplier's Order Status endpoint. Call this to confirm which queryType values are valid before querying order status.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
Returns any open issues or exceptions associated with a specific order — such as artwork problems, backorder alerts, or production holds. Allows distributors to proactively communicate delays to their customers.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| queryType | integer | Required | 1=PO Number, 2=Supplier Order #, 3=Date Range |
| referenceNumber | string | Optional | PO or order number |
Order Shipment Notification Service
Operations & Documentation
Returns shipment notifications for fulfilled orders, including carrier, tracking numbers, ship date, and line-level shipped quantities. Poll this service to automatically update distributor order management systems with tracking information.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version (e.g. 2.0.0) |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| queryType | integer | Required | 1=PO Number, 2=Supplier Order #, 3=Date Range |
| referenceNumber | string | Optional | PO or order number (required for queryType 1 or 2) |
| shipmentTimestamp | dateTime | Optional | Start of date range for queryType 3 |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.promostandards.org/wsdl/OSN/2.0.0/"> <soapenv:Header/> <soapenv:Body> <ns:GetOrderShipmentNotificationRequest> <ns:wsVersion>2.0.0</ns:wsVersion> <ns:id>YOUR_USERNAME</ns:id> <ns:password>YOUR_PASSWORD</ns:password> <ns:queryType>1</ns:queryType> <ns:referenceNumber>PO-12345</ns:referenceNumber> </ns:GetOrderShipmentNotificationRequest> </soapenv:Body> </soapenv:Envelope>
Purchase Order Service
Operations & Documentation
Returns the order types accepted by this supplier (e.g. Blank, Sample, Production, Rush). Call this before submitting a PO to confirm the order type is supported.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version (e.g. 1.0.0) |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
Submits a purchase order to Scrub Authority. This is the primary transaction operation — include full line-item detail, shipping address, decoration instructions, and artwork references. Response confirms receipt and provides the supplier order number.
| Parameter | Type | Required | Description |
|---|---|---|---|
| wsVersion | string | Required | Service version |
| id | string | Required | Your API username |
| password | string | Required | Your API password |
| PO | complex | Required | Full PO object — see WSDL for complete schema |
| Field | Description |
|---|---|
| orderType | Blank / Sample / Production / Rush |
| orderDate | ISO 8601 datetime the order was placed |
| lastModified | ISO 8601 datetime of last change |
| totalAmount | Expected total order value |
| Rush | Boolean — request rush processing |
| LineItemArray | Array of line items (product, quantity, decoration) |
| ShipmentArray | Array of shipment destinations with addresses |
| Contact | Distributor contact for this order |
The SendPO schema is complex. Refer to the WSDL or the PromoStandards specification for the full message structure.
Authentication
All requests require a valid username (id) and password passed in the SOAP request body. Credentials are issued per distributor — they are not shared or publicly available.
- To request credentials, contact your Scrub Authority sales representative or email us at the address below.
- Credentials are specific to your distributor account and must not be shared.
- All communication is over HTTPS — do not send credentials over unencrypted connections.
Technical Support
For integration assistance, WSDL questions, or to report an issue with any endpoint:
- Email: integrations@scrubauthority.com
- Please include your distributor name, the endpoint and operation you're calling, and a sample request/response when reporting issues.