Product Identification API (1)

Download OpenAPI specification:Download

This API provides services to upload, manipulate and download Global Trade Item data in the CDQ Cloud

Global Trade Items

-> Covers several operations including the creation, reading, updating, and deletion of Global Trade Items, as well as the management of references between Global Trade Items and business partners. The endpoints under this tag are designed to handle data related to Global Trade Items, which are unique identifiers for products in the global marketplace.

Create Global Trade Item

Provide a new Global Trade Item with unique GTIN and name.

SecurityapiKey
Request
Request Body schema: application/json
required
gtin
required
string (Gtin)

A 13 digit Global Trade Item Number that uniquely identifies the item

Example: "5099206081901"
name
required
string (ItemName)

Human readable name of the item.

Example: "Business Partner Update Browser"
Responses
200

OK

400

Bad Request

post/globaltradeitems
Request samples
application/json
{
  • "gtin": "5099206081901",
  • "name": "Business Partner Update Browser"
}
Response samples
application/json
{
  • "gtin": "5099206081901",
  • "name": "Business Partner Update Browser",
  • "businessPartnerReferences": [
    ]
}

Create Global Trade Item Reference

Create a reference between Global Trade Item and Business Partner.

SecurityapiKey
Request
path Parameters
gtin
required
string (Gtin)

Unique Global Trade Item Number.

Example: 5099206081901
Request Body schema: application/json
required
required
Array of objects (BusinessPartnerReferenceCreate) <= 30 items

List of Business Partners to be referenced.

Responses
200

OK

400

Bad Request

post/globaltradeitems/{gtin}/businesspartnerreferences
Request samples
application/json
{
  • "businessPartnerReferences": [
    ]
}
Response samples
application/json
{
  • "results": [
    ]
}

Delete Global Trade Item References

Delete references between Global Trade Item and Business Partner.

SecurityapiKey
Request
path Parameters
gtin
required
string (Gtin)

Unique Global Trade Item Number.

Example: 5099206081901
Request Body schema: application/json
required
required
Array of objects (BusinessPartnerReferenceDelete) <= 30 items

List of Business Partner References to be deleted.

Responses
200

OK

400

Bad Request

post/globaltradeitems/{gtin}/businesspartnerreferences/delete
Request samples
application/json
{
  • "businessPartnerReferences": [
    ]
}
Response samples
application/json
{
  • "results": [
    ]
}

Delete Global Trade Items

Delete multiple Global Trade Items by GTIN.

SecurityapiKey
Request
Request Body schema: application/json
required
required
Array of objects (GlobalTradeItemDelete) non-empty

List of Global Trade Items to be deleted.

Responses
200

OK

post/globaltradeitems/delete
Request samples
application/json
{
  • "globalTradeItems": [
    ]
}
Response samples
application/json
{
  • "results": [
    ]
}

List Global Trade Items

Provide a list of Global Trade Items with optional filtering and pagination.

SecurityapiKey
Request
query Parameters
businessPartnerIds
Array of strings (BusinessPartnerId)

Filter Global Trade Items by Business Partners ID that are referenced.

Example: businessPartnerIds=63e635235c06b7396330fe40
featuresOn
Array of strings (GlobalTradeItemsReadFeatureParam)

Features to be turned on:

  • FETCH_BUSINESS_PARTNER_REFERENCES - Includes businessPartnerReferences. By default, turned off.
  • NUMBER_OF_TOTAL - Allows switching fetching the total number of Global Trade Items to improve performance. By default turned off.
Items Enum: Description
FETCH_BUSINESS_PARTNER_RELATIONS

Includes businessPartnerReferences.

NUMBER_OF_TOTAL

Allows switching fetching the total number of Global Trade Items to improve performance.

Example: featuresOn=FETCH_BUSINESS_PARTNER_RELATIONS
limit
integer <int32> >= 1
Default: 500

Number of items to be returned on the page.

Example: limit=500
startAfter
string

Use nextStartAfter provided in the response of previous call as an indicator for a next page.

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
Responses
200

OK

get/globaltradeitems
Request samples 
Response samples 
application/json
{
  • "total": "67",
  • "limit": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "values": [
    ]
}
Read Global Trade Item
Provide a single Global Trade Item with the given GTIN.


SecurityapiKey 
Request 
path Parameters
gtin
required
string (Gtin) 
Unique Global Trade Item Number.


 
 Example:  5099206081901
Responses 
200
OK


get/globaltradeitems/{gtin}
Request samples 
Response samples 
application/json
{
  • "globalTradeItem": {
    },
  • "status": "OK"
}
Update Global Trade Items
Allows updating the Global Trade Item.


SecurityapiKey 
Request 
path Parameters
gtin
required
string (Gtin) 
Unique Global Trade Item Number.


 
 Example:  5099206081901
Request Body schema: application/json
required
name
string (ItemName) 
Human readable name of the item.


 
 Example:  "Business Partner Update Browser"
Responses 
200
OK


patch/globaltradeitems/{gtin}
Request samples 
application/json
{
  • "name": "Business Partner Update Browser"
}
Response samples 
application/json
{
  • "globalTradeItem": {
    },
  • "status": "OK"
}