Retrieve the details of a specific Price List

GET   /seiapi/v3/PriceList/${PriceListID}  

Retrieve the price for a product from a specific Price List

GET   /seiapi/v3/PriceList/${PriceListID}/Price /${ProductNum}

Retrieve all Service Areas associated with a specific Price List 

GET /seiapi/v3/PriceList/{PriceListID}/ServiceAreas

Insert or Update the details for a specific Price List

PUT /seiapi/v3/PriceList/${PriceListID}

Insert or Update the Service Areas associated with a specific Price List

PUT /seiapi/v3/PriceList/${PriceListID}/ServiceAreas

Delete a specific Price List

DELETE /seiapi/v3/PriceList/${PriceListID}

Copy the details of a specific Price List

PUT /seiapi/v3/PriceList/${PriceListID}/copy/${TargetPriceListID}

Retrieve the details of a specific Price List

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the HTTP response code will be 200 and the response body will contain a valid Price List Object. 

If the price list does not have any pricing defined an HTTP response code of 404 (not found) will be returned.

Retrieve the price for a product from a specific Price List

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the HTTP response code will be 200 and the response body will contain a valid object with a price. 

If the price list does not have any pricing defined an HTTP response code of 404 (not found) will be returned.

Retrieve the Service Areas for a specific Price List

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the HTTP response code will be 200 and the response body will contain a collection of ServiceAreaIDs

If the price list has no associated Service Areas defined, the response will include an empty collection of ServiceAreaIDs.

Insert or Update the details for a specific Price List

This request is always an update, not a full replace. Therefore, new items will be added to the price list while existing items in the PUT request will be updated with the new price. If an item in the PUT request has the  Delete property set to  true , then that item will be removed from the price list. 

URL

HTTP Request

The request body contains a single Price List Object. 

 {
 	"ISOCurrencySymbol": "",
 	"Name": "",
 	"PriceListID": "",
 	"Prices": {
 		"{$ProdNum}": {
 			"Price": 0.0,
 			"Delete": false
 		}
 	}
 }

HTTP Response 

On success the API will return a response code of 200.

Insert or Update the Service Areas for a specific Price List

This request is a full replace.

URL

HTTP Request

The request body contains a collection of ServiceAreaIDs

 {
 	"ServiceAreas": [{
     	// A collection of ServiceAreaIDs
     }]
}

HTTP Response 

On success the API will return a response code of 200. Otherwise, on error, the response body will contain a descriptive reason for the error.

Delete a specific Price List

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the HTTP response code will be 200. 

If you try and delete price list when there currently is not any setup then an HTTP response code of 404 (not found) will be returned. 

Copy the details of a specific Price List

This request will copy the details of source price list into the target price list. The target price list with specified ID must not exist in the system. Copy Price List object contains price adjustments and override definition for items in target price list. If an item in the PriceOverride property has the  Delete property set to  true, then that item will be removed from the price list. 

• PriceAdjustments or PriceOverride property must be present in the request.
• The system will apply price adjustments first, which will followed by price override for each item.
• PriceListID for master price list is "MasterPriceList". This ID is reserved for system use.

URL

HTTP Request

The request body contains a single Copy Price List Object. 

 {
	"ISOCurrencySymbol": "USD",
	"Name": "",
	"PriceAdjustments": [{
		"ProdType": "",
		"Operator": "",
		"Value": 10
	}],
	"PriceListID": "",
	"PriceOverride": {
		"{$ProdNum}": {
			"Price": 133
		}
	}
}

HTTP Response 

On success the API will return a response code of 200.