Update an existing Trade Item

Brand

Operations

Trade Item

Operations

Search Trade Items by filter

Request

Search Trade Items by filter

Security

Bearer

Query

OwnerCompanyIdstring(uuid)required

BrandIdstring

CategoryIdstring

CategoryItemIdstring

GTINstring

NetContentValuestring

NetContentUnitstring

ItemNamestring

ProductRangestring

FunctionalNamestring

Variantstring

PackagingFormatstring

IsTradeItemVariableUnitstring

IsTradeItemBaseUnitstring

IsTradeItemSeasonalstring

SeasonalAvailabilityStartDatestring

SeasonalAvailabilityEndDatestring

ProductTypeIdstring

DietTypeCodeIdstring

TradeItemStatusstring

Skipstring

Takestring

curl -i -X GET \
  'https://www.developers.traceone.com/api/tradeitems?OwnerCompanyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&BrandId=string&CategoryId=string&CategoryItemId=string&GTIN=string&NetContentValue=string&NetContentUnit=string&ItemName=string&ProductRange=string&FunctionalName=string&Variant=string&PackagingFormat=string&IsTradeItemVariableUnit=string&IsTradeItemBaseUnit=string&IsTradeItemSeasonal=string&SeasonalAvailabilityStartDate=string&SeasonalAvailabilityEndDate=string&ProductTypeId=string&DietTypeCodeId=string&TradeItemStatus=string&Skip=string&Take=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

tradeItemsArray of objects or null(List`1)

skipAndTakeQueryStatsobject or null(SkipAndTakeQueryStats)

Response

application/json

{
  "tradeItems": [
    { … }
  ],
  "skipAndTakeQueryStats": {
    "totalCount": 0,
    "currentCount": 0
  }
}

Create a new Trade Item

Request

Create a new Trade Item

Security

Bearer

Body

tradeItemNamestringnon-emptyrequired

ownerCompanyIdstring(uuid)required

tradeItemIdstring or null

gtinstring or null

brandIdstring or null

categoryListIdstring or null

[Obsolete] This attribute is deprecated. Please use ProductCategories attribute instead.

categoryItemIdstring or null

[Obsolete] This attribute is deprecated. Please use ProductCategories attribute instead.

netContentValuestring or null

[Obsolete] This attribute is deprecated. Please use NetContents attribute instead.

netContentUnitstring or null

[Obsolete] This attribute is deprecated. Please use NetContents attribute instead.

packagingFormatstring or null

productTypeIdstring or null

tradeItemStatusIdstring or null

ean7Weightstring or null

ean7Pricestring or null

retailerIdentifiersArray of strings or null(List`1)

retailerProductManagerstring or null

[Obsolete] This attribute is deprecated. Please use Contacts attribute instead.

retailerPackagingManagerstring or null

[Obsolete] This attribute is deprecated. Please use Contacts attribute instead.

retailerQualityManagerstring or null

[Obsolete] This attribute is deprecated. Please use Contacts attribute instead.

productRangestring or null

functionalNamestring or null

variantstring or null

isTradeItemVariableUnitstring or null

isTradeItemBaseUnitstring or null

isTradeItemSeasonalstring or null

seasonalAvailabilityStartDatestring or null

seasonalAvailabilityEndDatestring or null

dietTypeCodeIdstring or null

netContentsArray of objects or null(List`1)

packagingNetContentDescriptionstring or null

manufacturingPeriodstring or null

commentsArray of objects or null(List`1)

retailerCustomizedAttributesArray of objects or null(List`1)

isConsumerUnitstring or null

productCategoriesArray of objects or null(List`1)

multipackstring or null

productLanguagestring or null

contactsArray of objects or null(List`1)

customProductTypeIdstring or null

createdBystring or null

UserId of the Creator. This attribute can be used only for Internal Service requests

harmonizedCodestring or null

drainedNetWeightobject or null(DrainedNetWeight)

Allowed only g (gram), kg (kilogram) and mg (milligram), cg (centigram), dg (decigram), mcg (microgram), ton

variableWeightobject or null(VariableWeight)

Allowed only g (gram), kg (kilogram) and mg (milligram), cg (centigram), dg (decigram), mcg (microgram), ton

curl -i -X POST \
  https://www.developers.traceone.com/api/tradeItem \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "tradeItemName": "string",
    "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
    "tradeItemId": "string",
    "gtin": "string",
    "brandId": "string",
    "categoryListId": "string",
    "categoryItemId": "string",
    "netContentValue": "string",
    "netContentUnit": "string",
    "packagingFormat": "string",
    "productTypeId": "string",
    "tradeItemStatusId": "string",
    "ean7Weight": "string",
    "ean7Price": "string",
    "retailerIdentifiers": [
      "string"
    ],
    "retailerProductManager": "string",
    "retailerPackagingManager": "string",
    "retailerQualityManager": "string",
    "productRange": "string",
    "functionalName": "string",
    "variant": "string",
    "isTradeItemVariableUnit": "string",
    "isTradeItemBaseUnit": "string",
    "isTradeItemSeasonal": "string",
    "seasonalAvailabilityStartDate": "string",
    "seasonalAvailabilityEndDate": "string",
    "dietTypeCodeId": "string",
    "netContents": [
      {
        "value": "string",
        "unitOfMeasure": "string"
      }
    ],
    "packagingNetContentDescription": "string",
    "manufacturingPeriod": "string",
    "comments": [
      {
        "value": "string",
        "authorId": "string",
        "commentDate": "string"
      }
    ],
    "retailerCustomizedAttributes": [
      {
        "retailerLabel": "string",
        "retailerCode": "string"
      }
    ],
    "isConsumerUnit": "string",
    "productCategories": [
      {
        "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
        "categoryItemId": "9dc235b8-97fe-4787-a18a-815fdf4bdcf7"
      }
    ],
    "multipack": "string",
    "productLanguage": "string",
    "contacts": [
      {
        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
        "responsibilityId": "50587ee7-cd41-4bdd-be00-1a99378d5d94"
      }
    ],
    "customProductTypeId": "string",
    "createdBy": "string",
    "harmonizedCode": "string",
    "drainedNetWeight": {
      "value": 0.1,
      "unitOfMeasure": "dcedd711-dfe3-4b26-9246-543e8fb07861"
    },
    "variableWeight": {
      "minimumValue": 0.1,
      "maximumValue": 0.1,
      "unitOfMeasure": "dcedd711-dfe3-4b26-9246-543e8fb07861"
    }
  }'

Responses

Success

Bodyapplication/json

tradeItemIdstring(uuid)

Response

application/json

{
  "tradeItemId": "ca25da54-cf50-4957-b1f6-2a6f444fe8a3"
}

Archive a collection of TradeItems

Request

Archive a collection of TradeItems

Security

Bearer

Body

idCollectionArray of strings(uuid)(List`1)required

curl -i -X DELETE \
  https://www.developers.traceone.com/api/tradeitems/enable/collections \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "idCollection": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

OK

Response

No content

Unarchive a TradeItem

Request

Unarchive a TradeItem for the Current Company

Security

Bearer

Path

idstring(uuid)required

curl -i -X POST \
  'https://www.developers.traceone.com/api/tradeitems/{id}/enable' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

tradeItemIdstring(uuid)

Response

application/json

{
  "tradeItemId": "ca25da54-cf50-4957-b1f6-2a6f444fe8a3"
}

Partial update an existing Trade Item

Request

Partial update an existing Trade Item

Security

Bearer

Path

idstring(uuid)required

Bodyapplication/json-patch+json

tradeItemNamestring or null

gtinstring or null

brandIdstring or null

categoryListIdstring or null

[Obsolete] This attribute is deprecated. Please use ProductCategories attribute instead.

categoryItemIdstring or null

[Obsolete] This attribute is deprecated. Please use ProductCategories attribute instead.

netContentValuestring or null

[Obsolete] This attribute is deprecated. Please use NetContents attribute instead.

netContentUnitstring or null

[Obsolete] This attribute is deprecated. Please use NetContents attribute instead.

packagingFormatstring or null

productTypeIdstring or null

tradeItemStatusIdstring or null

ean7Weightstring or null

ean7Pricestring or null

retailerIdentifiersArray of strings or null(List`1)

retailerProductManagerstring or null

[Obsolete] This attribute is deprecated. Please use Contacts attribute instead.

retailerPackagingManagerstring or null

[Obsolete] This attribute is deprecated. Please use Contacts attribute instead.

retailerQualityManagerstring or null

[Obsolete] This attribute is deprecated. Please use Contacts attribute instead.

productRangestring or null

functionalNamestring or null

variantstring or null

isTradeItemVariableUnitstring or null

isTradeItemBaseUnitstring or null

isTradeItemSeasonalstring or null

seasonalAvailabilityStartDatestring or null

seasonalAvailabilityEndDatestring or null

dietTypeCodeIdstring or null

netContentsArray of objects or null(List`1)

packagingNetContentDescriptionstring or null

manufacturingPeriodstring or null

retailerCustomizedAttributesArray of objects or null(List`1)

isConsumerUnitstring or null

commentsArray of objects or null(List`1)

productCategoriesArray of objects or null(List`1)

contactsArray of objects or null(List`1)

customProductTypeIdstring or null

drainedNetWeightobject or null(DrainedNetWeight)

variableWeightobject or null(VariableWeight)

curl -i -X PATCH \
  'https://www.developers.traceone.com/api/tradeItems/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "tradeItemName": "string",
    "gtin": "string",
    "brandId": "string",
    "categoryListId": "string",
    "categoryItemId": "string",
    "netContentValue": "string",
    "netContentUnit": "string",
    "packagingFormat": "string",
    "productTypeId": "string",
    "tradeItemStatusId": "string",
    "ean7Weight": "string",
    "ean7Price": "string",
    "retailerIdentifiers": [
      "string"
    ],
    "retailerProductManager": "string",
    "retailerPackagingManager": "string",
    "retailerQualityManager": "string",
    "productRange": "string",
    "functionalName": "string",
    "variant": "string",
    "isTradeItemVariableUnit": "string",
    "isTradeItemBaseUnit": "string",
    "isTradeItemSeasonal": "string",
    "seasonalAvailabilityStartDate": "string",
    "seasonalAvailabilityEndDate": "string",
    "dietTypeCodeId": "string",
    "netContents": [
      {
        "value": "string",
        "unitOfMeasure": "string"
      }
    ],
    "packagingNetContentDescription": "string",
    "manufacturingPeriod": "string",
    "retailerCustomizedAttributes": [
      {
        "retailerLabel": "string",
        "retailerCode": "string"
      }
    ],
    "isConsumerUnit": "string",
    "comments": [
      {
        "id": "string",
        "value": "string",
        "authorId": "string",
        "commentDate": "string"
      }
    ],
    "productCategories": [
      {
        "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
        "categoryItemId": "9dc235b8-97fe-4787-a18a-815fdf4bdcf7"
      }
    ],
    "contacts": [
      {
        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
        "responsibilityId": "50587ee7-cd41-4bdd-be00-1a99378d5d94"
      }
    ],
    "customProductTypeId": "string",
    "drainedNetWeight": {
      "value": 0.1,
      "unitOfMeasure": "dcedd711-dfe3-4b26-9246-543e8fb07861"
    },
    "variableWeight": {
      "minimumValue": 0.1,
      "maximumValue": 0.1,
      "unitOfMeasure": "dcedd711-dfe3-4b26-9246-543e8fb07861"
    }
  }'

Responses

Success

Bodyapplication/json

tradeItemIdstring(uuid)

Response

application/json

{
  "tradeItemId": "ca25da54-cf50-4957-b1f6-2a6f444fe8a3"
}