Product Identification API (1)

Download OpenAPI specification:Download

Michal Malinka: michal.malinka@cdq.com URL: https://www.cdq.ch/team

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

Global Trade Items

Global Trade Items

Create Global Trade Item

Create Global Trade Item

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 Global Trade Item References

SecurityapiKey
Request
path Parameters
gtin
required
string (Gtin)

GTIN

Example: 5099206081901
Request Body schema: application/json
required
required
Array of objects (BusinessPartnerReferenceCreate) <= 30 items
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 Global Trade Item References

SecurityapiKey
Request
path Parameters
gtin
required
string (Gtin)

GTIN

Example: 5099206081901
Request Body schema: application/json
required
required
Array of objects (BusinessPartnerReferenceDelete) <= 30 items
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 Global Trade Items.

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

OK

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

Read Global Trade Item

Read Global Trade Item by GTIN.

SecurityapiKey
Request
path Parameters
gtin
required
string (Gtin)

GTIN

Example: 5099206081901
Responses
200

OK

get/globaltradeitems/{gtin}
Request samples 
Response samples 
application/json
{
  • "globalTradeItem": {
    },
  • "status": "string"
}
Read Global Trade Items
Read Global Trade Items


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 to switch fetching the total number of Global Trade Items to improve performance. By default turned off.
    • 



Items Enum: "FETCH_BUSINESS_PARTNER_RELATIONS" "NUMBER_OF_TOTAL"  
limit
integer <int32>   >= 1 
 Default:  500
Number of items to be returned on the page.


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


 
Responses 
200
OK


get/globaltradeitems
Request samples 
Response samples 
application/json
{
  • "total": "67",
  • "limit": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "values": [
    ]
}
Update Global Trade Items
Update Global Trade Items.


SecurityapiKey 
Request 
path Parameters
gtin
required
string (Gtin) 
GTIN


 
 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": "string"
}