POST api/RegistryGtin

Request Information

URI Parameters

None.

Body Parameters

Collection of GtinType

Name	Type	Additional information
licenceKey	string	None.
gtin	string	Required Matching regular expression pattern: ^\d{14}$
licenceType	string	None.
gtinStatus	string	Required Matching regular expression pattern: ^(ACTIVE\|INACTIVE)$ Max length: 8
brandName	Collection of BrandNameType	None.
gpcCategoryCode	string	Required Range: inclusive between 10000000 and 99999999
countryOfSaleCode	Collection of string	None.
productDescription	Collection of tradeItemDescriptionType	Required
productImageUrl	Collection of tradeItemImageUrlType	None.
netContent	Collection of netContentType	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "licenceKey": "sample string 5",
    "gtin": "sample string 6",
    "licenceType": "sample string 7",
    "gtinStatus": "sample string 8",
    "brandName": [
      {
        "language": "sample string 2",
        "value": "sample string 3"
      },
      {
        "language": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "gpcCategoryCode": "sample string 9",
    "countryOfSaleCode": [
      "sample string 1",
      "sample string 2"
    ],
    "productDescription": [
      {
        "language": "sample string 2",
        "value": "sample string 3"
      },
      {
        "language": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "productImageUrl": [
      {
        "language": "sample string 1",
        "value": "sample string 2"
      },
      {
        "language": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "netContent": [
      {
        "value": "sample string 2",
        "unitCode": "sample string 3"
      },
      {
        "value": "sample string 2",
        "unitCode": "sample string 3"
      }
    ]
  },
  {
    "licenceKey": "sample string 5",
    "gtin": "sample string 6",
    "licenceType": "sample string 7",
    "gtinStatus": "sample string 8",
    "brandName": [
      {
        "language": "sample string 2",
        "value": "sample string 3"
      },
      {
        "language": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "gpcCategoryCode": "sample string 9",
    "countryOfSaleCode": [
      "sample string 1",
      "sample string 2"
    ],
    "productDescription": [
      {
        "language": "sample string 2",
        "value": "sample string 3"
      },
      {
        "language": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "productImageUrl": [
      {
        "language": "sample string 1",
        "value": "sample string 2"
      },
      {
        "language": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "netContent": [
      {
        "value": "sample string 2",
        "unitCode": "sample string 3"
      },
      {
        "value": "sample string 2",
        "unitCode": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfGtinType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GS1Mx.Verified.Models">
  <GtinType>
    <AccountId>1</AccountId>
    <BaseCode>sample string 5</BaseCode>
    <BatchId>sample string 4</BatchId>
    <BrandName>
      <BrandNameType>
        <brandNameTypeId>1</brandNameTypeId>
        <language>sample string 2</language>
        <value>sample string 3</value>
      </BrandNameType>
      <BrandNameType>
        <brandNameTypeId>1</brandNameTypeId>
        <language>sample string 2</language>
        <value>sample string 3</value>
      </BrandNameType>
    </BrandName>
    <FullAttributes>true</FullAttributes>
    <GpcCode>sample string 9</GpcCode>
    <Gtin>sample string 6</Gtin>
    <IndividualCodeId>2</IndividualCodeId>
    <LicenceType>sample string 7</LicenceType>
    <NetContent>
      <netContentType>
        <measurementUnitCode>sample string 3</measurementUnitCode>
        <netContentTypeId>1</netContentTypeId>
        <quantity>sample string 2</quantity>
      </netContentType>
      <netContentType>
        <measurementUnitCode>sample string 3</measurementUnitCode>
        <netContentTypeId>1</netContentTypeId>
        <quantity>sample string 2</quantity>
      </netContentType>
    </NetContent>
    <Status>sample string 8</Status>
    <TargetMarketCountryCode xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TargetMarketCountryCode>
    <TradeItemDescription>
      <tradeItemDescriptionType>
        <language>sample string 2</language>
        <tradeItemDescriptionTypeId>1</tradeItemDescriptionTypeId>
        <value>sample string 3</value>
      </tradeItemDescriptionType>
      <tradeItemDescriptionType>
        <language>sample string 2</language>
        <tradeItemDescriptionTypeId>1</tradeItemDescriptionTypeId>
        <value>sample string 3</value>
      </tradeItemDescriptionType>
    </TradeItemDescription>
    <TradeItemImageUrl>
      <tradeItemImageUrlType>
        <language>sample string 1</language>
        <value>sample string 2</value>
      </tradeItemImageUrlType>
      <tradeItemImageUrlType>
        <language>sample string 1</language>
        <value>sample string 2</value>
      </tradeItemImageUrlType>
    </TradeItemImageUrl>
  </GtinType>
  <GtinType>
    <AccountId>1</AccountId>
    <BaseCode>sample string 5</BaseCode>
    <BatchId>sample string 4</BatchId>
    <BrandName>
      <BrandNameType>
        <brandNameTypeId>1</brandNameTypeId>
        <language>sample string 2</language>
        <value>sample string 3</value>
      </BrandNameType>
      <BrandNameType>
        <brandNameTypeId>1</brandNameTypeId>
        <language>sample string 2</language>
        <value>sample string 3</value>
      </BrandNameType>
    </BrandName>
    <FullAttributes>true</FullAttributes>
    <GpcCode>sample string 9</GpcCode>
    <Gtin>sample string 6</Gtin>
    <IndividualCodeId>2</IndividualCodeId>
    <LicenceType>sample string 7</LicenceType>
    <NetContent>
      <netContentType>
        <measurementUnitCode>sample string 3</measurementUnitCode>
        <netContentTypeId>1</netContentTypeId>
        <quantity>sample string 2</quantity>
      </netContentType>
      <netContentType>
        <measurementUnitCode>sample string 3</measurementUnitCode>
        <netContentTypeId>1</netContentTypeId>
        <quantity>sample string 2</quantity>
      </netContentType>
    </NetContent>
    <Status>sample string 8</Status>
    <TargetMarketCountryCode xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TargetMarketCountryCode>
    <TradeItemDescription>
      <tradeItemDescriptionType>
        <language>sample string 2</language>
        <tradeItemDescriptionTypeId>1</tradeItemDescriptionTypeId>
        <value>sample string 3</value>
      </tradeItemDescriptionType>
      <tradeItemDescriptionType>
        <language>sample string 2</language>
        <tradeItemDescriptionTypeId>1</tradeItemDescriptionTypeId>
        <value>sample string 3</value>
      </tradeItemDescriptionType>
    </TradeItemDescription>
    <TradeItemImageUrl>
      <tradeItemImageUrlType>
        <language>sample string 1</language>
        <value>sample string 2</value>
      </tradeItemImageUrlType>
      <tradeItemImageUrlType>
        <language>sample string 1</language>
        <value>sample string 2</value>
      </tradeItemImageUrlType>
    </TradeItemImageUrl>
  </GtinType>
</ArrayOfGtinType>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RegistryGtinResponse

Name	Type	Additional information
lstGtinResponses	Collection of GtinResponses	None.
errorMessage	string	None.
batchId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "lstGtinResponses": [
    {
      "Gtin": "sample string 1",
      "Code": 2,
      "ResultMessage": "sample string 3",
      "FullAttributes": true
    },
    {
      "Gtin": "sample string 1",
      "Code": 2,
      "ResultMessage": "sample string 3",
      "FullAttributes": true
    }
  ],
  "errorMessage": "sample string 1",
  "batchId": "sample string 2"
}

application/xml, text/xml

Sample:

<RegistryGtinResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GS1Mx.Verified.Models.Responses">
  <batchId>sample string 2</batchId>
  <errorMessage>sample string 1</errorMessage>
  <lstGtinResponses>
    <GtinResponses>
      <Code>2</Code>
      <FullAttributes>true</FullAttributes>
      <Gtin>sample string 1</Gtin>
      <ResultMessage>sample string 3</ResultMessage>
    </GtinResponses>
    <GtinResponses>
      <Code>2</Code>
      <FullAttributes>true</FullAttributes>
      <Gtin>sample string 1</Gtin>
      <ResultMessage>sample string 3</ResultMessage>
    </GtinResponses>
  </lstGtinResponses>
</RegistryGtinResponse>