Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.11.0
 
Status
colourYellow
title3.20.0

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

 



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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 REST Object Definitions Inventory Related Objects Product Object.

Include Page
_URI Default HTTP Headers
_URI Default HTTP Headers


API Specifics


Panel

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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. 

Include Page
_Product Object Formats
_Product Object Formats


Panel

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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. 


Panel

Bulk Insert or Update details for Products

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /seiapi/v3/trans/Products

HTTP Request Body

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

Code Block
languagejs
firstline1
titleJSON Formatfirstline1
linenumberstrue
collapsetrue
{
    "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. 


Panel

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.