GS1 Digital Link

Create a GS1 product

Creates (or reuses, if the identifier already exists on the resolver domain) a GS1 product. destination_url seeds a default gs1:pip link.

post/gs1/products/

Request

  • Base URL: https://hovercode.com/api/v2
  • URL: https://hovercode.com/api/v2/gs1/products/
  • Auth: API key in header Authorization

Request body

workspacestring uuid required
identifier_type'01' | '00' | '414' | '417' | '253' | '255' | '401' | '402' | '8003' | '8004' | '8006' | '8010' | '8013' | '8017' | '8018'

GS1 Application Identifier (01 = GTIN).

identifier_valuestring required

Validated, including the GS1 check digit where applicable.

batch_lotstring nullable
serial_numberstring nullable
expiry_datestring nullable

YYMMDD.

destination_urlstring

Seeds a default gs1:pip link.

domainstring

Resolver domain available to your workspace (optional).

Response

Product created.

idstring uuid required
identifier_type'01' | '00' | '414' | '417' | '253' | '255' | '401' | '402' | '8003' | '8004' | '8006' | '8010' | '8013' | '8017' | '8018' required

GS1 Application Identifier (01 = GTIN).

identifier_valuestring required

Validated, including the GS1 check digit where applicable.

batch_lotstring nullable
serial_numberstring nullable
expiry_datestring nullable

YYMMDD.

domainstring nullable

Resolver domain; set at create time.

identifier_labelstring
digital_link_pathstring
createdstring date-time

Example response

{
  "link_types": [
    {
      "language": "en"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.