Authentication

Authentication details can be found/created in admin under sales > customer account.
AccountCode, PromoPassword and PromoAuthorize fields. Only authorized accounts can access the API's

The default user for an account will be used for visibility and pricing calculations, orders will also be placed with this user. If you haven't configured a user it will default to the first user.

Override Price - Used to create purchase order.

1. ODSNet Price - Takes ODSNet Prices based on the user
2. Requested Price - Takes requested price from Purcahse order request
3. Reject Order - Reject order if requested price does not match with ODSNet price

The below errors can be returned due to authenticating issues when using Promo Standards.

Inventory

Documentation link : https://promostandards.org/service/view/16/ 

getFilterValues ()

Will return all available filters (partId, labelSize, partColor) for a successful request

getInventoryLevels ()

Will return available stock from SAP for a successful request 

Below are the errors you can receive when using this api.

Invoice

Documentation link: https://promostandards.org/service/view/20/

This API will return the customer's invoices from SAP.

Users can filter invoices by QueryType.

Below are the errors you can receive when using this api.

Media Content

Documentation link : https://promostandards.org/service/view/11/ 

getMediaContent()

Will return available media for passed product and filters. 

getMediaDateModified()

Will return products which media has changed after passed date. 

Below are the errors you can recieve when using this api.

Order Shipment Notification

Order Status

Documentation link: https://promostandards.org/service/view/1/

Start with API Endpoints:

getOrderStatusDetails:

This API will return detailed information of an Order, including the status from SAP.

It will filter orders based on QueryType entered, check field mapping excel or API documentation.

getOrderStatusTypes: 

This API will return a list of Order Statuses from SAP which we support.

Below are the errors you can receive when using this api.

Product Data

Documentation link: https://promostandards.org/service/view/18/

Start with API Endpoints:

getProduct:

This function will provide detailed product information for its parts(GenericItems) by passing a ProductId or any additional optional subset filtering provided at the request.

Pass required parameters to the request and It will return MainProduct (GenericDefault). and all GenericItmes of the main product which are called product parts.

In the request partId, colorName, apparelStyle, and labelSize parameters are used to do filters on GenericItems (product parts).

All the products are display based on customer visibility and its pricing, if pricing doesn't exist then the product will not display in response.

It will display only those products which are active and available for sale.

getProductDateModified:

This function will provide a list of ProductGenericCode(ProductId) and optional ProductDetailSkuCode(Part Ids) for all items which have changed since the date supplied in the request.

The ProductId and PartIds are display based on customer visibility and pricing, if pricing doesn't exist then it will not display in the response.

It will display only where the productId and PartId are active and available for sale.  

getProductCloseOut

This function will provide a list of ProductGenericCode(ProductId) and optional ProductDetailSkuCode(Part Ids) for all items where currently the ProductDetailActiveFlag is N. 

A list of inactive products.

getProductSellable

This function will provide a list of ProductGenericCode(ProductId) and optional ProductDetailSkuCode(Part Ids) along with their status of available to sell (Sellable TRUE or FALSE).

If you pass Sellable True in the request it will return a list of products which are available for sale

If you pass Sellable false in the request it will return a list of products that are not available for sale.

You can filter it by a specific part Id.

Below are the errors you can receive when using this api.

Product Pricing and Configuration

Purchase Order

Documentation link : https://promostandards.org/service/view/15/ 

getSupportedOrderTypes()

This will return the order types supported by ODSNet. 
As of now only Blank is supported.

sendPO()

This will create an order in ODSNet, there are some fields that we currently do not use.
If you don't specify pricing, it will be calculated from ODSNet.
Please see below a successful request and response.

Please see below a a failed request.

The below errors can be found if there is an issue with the details used when placing a purchase order.

ODSNet changes

The below changes have been made to the ODSnet platform in relation to Integrating the Promo standards API's.

Database changes

System configuration

This system configuration is for setting the paths on the hosting webserver for the logs of the successful and failed api requests and responses.

Windows service

This is a service that can be enabled to purge the above logs so that they do not take up too much storage.