/
Products REST API

Products REST API

3.11.0 3.20.0

The Products REST API is used to create, get, update or delete product objects. 


On this page:

Related pages:

Resource URL Summary

Retrieve details for a specific Product

GET /seiapi/v3/trans/Products/${ProdNum}

Insert or Update the details for a specific Product

PUT /seiapi/v3/trans/Products/${ProdNum}

Bulk Insert or Update details for Products

POST /seiapi/v3/trans/Products

Delete a specific Product

DELETE /seiapi/v3/trans/Products/${ProdNum}

API Specific Parameters

ParameterDescription
${ProdNum}Identifies the Product Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve details for a specific Product

This REST API will return a Product with the specified ID. The Product with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/Products/${ProdNum}  

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a Product Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

JSON Formt
{
	"AllowedShipToLocations": [],
    "Deleted": false,
	"Desc": {
		"en": ""
	},
	"GeneralIncomeAccount": "",
	"IsBatch": false,
	"IsInvCtrl": false,
	"IsOffline": true,
	"IsSerialized": false,
	"Mfg": "",
	"ModelNum": "",
	"NonDiscountable": false,
	"NonTaxable": false,
	"Price": {
		"en": 0
	},
	"ProdNum": "",
	"ProdSubType": "",
	"ProdType": "",
	"Tags": [],
	"UPCUnitCode": ""
}

Insert or Update the details for a specific Product

This REST API will add a new product to the system. The system will update product in case product number exists in the system.

URL

PUT /seiapi/v3/trans/Products/${ProdNum}

HTTP Request Body

The HTTP request body must contain a valid Product Object

HTTP Response

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

Bulk Insert or Update details for Products

This REST API will add/update one or more products in the system.

URL

POST /seiapi/v3/trans/Products

HTTP Request Body

The HTTP request body must be a JSON array of one or more Product Object definitions.

JSON Format
{
    "Products" : [
       {
          // Standard Product object definition
       },
       {
          // Standard Product object definition
       },
       {
          // etc., as required
       }
    ]
}

HTTP Response

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

Delete a specific Product

This REST API will delete a Product with the specified ID from the system. The Product with the specified ID must already exist in the system.

URL

DELETE /seiapi/v3/trans/Products/${ProdNum}

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent product.

Related content

UpdateProductInfo RESTified API
UpdateProductInfo RESTified API
More like this
Service Contract REST API
Service Contract REST API
More like this
Price List REST API
Price List REST API
More like this