Manual serial number import APIs

While most Producers sync serial number information via the Set Serialized Operations Manager Sync Rules API, serial number information can be imported manually. This is a more labor-intensive process and requires status updates for a single serial number to be made multiple times.

Upload Product Identifiers (REST)

Producers use this message to upload serial number information in CSV format so that the records can be added to the Product Information Manager serial number repository and shared with Consumers for verification. Product Directory records must exist before serial number information can be uploaded. Once the Upload Product Identifiers request is submitted, Product Information Exchange processes the message asynchronously. Use the processingId that is returned in the response to check the status of the upload in the Poll Product Identifiers API.

Guidelines

Element Type Description
fileType String Required. Identifies the file format (e.g. CSV).
fileToken String Required. The token returned by the file upload process.
records Array Required. The array containing all the packaging codes made available for verification. Must include all of the packaging codes that are in the CSV file.
  packagingCode String

Required. The serialized product's packaging code.
  packagingCodeType String

Required.

Indicates the type of the serialized product's associated packagingCode. Valid values:

  • GTIN-14
  • NTIN
  • CN-RESCODE
  • PPN

If a value is not specified, defaults to GTIN-14.

Example

{
    "t": {
        "v": 1,
        "m": "pim--producer-upload-product-identifiers--v1",
        "app-id": "393C3176-6F7C-438D-B06F-DDCDA21C2E5C"
    },
    "p": {
        "fileType": "csv",
        "fileToken": "12347654",
        "records": [
            {"packagingCode":"10312345678910", "packagingCodeType":"GTIN-14"},
            {"packagingCode":"10312345678911", "packagingCodeType":"GTIN-14"}
        ]
    }
}

Errors

See HTTP response status codes for standard error status codes.

Guidelines

Element Type Description
processingId String The unique identifier of the uploaded CSV file in the request. The Poll Product Identifiers Processing request uses the ID to check the status of the file upload.

Example

{
    "t": {
        "v": 1,
        "m": "pim--producer-upload-product-identifiers-response--v1",
        "app-id": "393C3176-6F7C-438D-B06F-DDCDA21C2E5C",
        "cid": ""
    },
    "p": {
        "processingId": "5a8fb7e9-1051-42ce-b33b-32307513fab5"
    }
}

Errors

See HTTP response status codes for standard error status codes.

Poll Product Identifiers Processing (REST)

Producers use this message to check the status of the asynchronously processed Upload Product Identifiers API request. Use the processingId returned in the initial Upload Product Identifiers response to check the status of the upload.

Guidelines

Element Type Description
processingId String Required. The unique identifier of the uploaded CSV file received from the Upload Product Identifiers response.

Example

{
  "t": {
    "v": 1,
    "m": "pim--producer-poll-processing-product-identifiers--v1",
    "app-id": "393C3176-6F7C-438D-B06F-DDCDA21C2E5C"
   },
  "p": {
	  "processingId": "5a8fb7e9-1051-42ce-b33b-32307513fab5"
  }
}

Errors

See HTTP response status codes for standard error status codes.

Guidelines

Element Type Description
processingState String Required. Reflects one of the following statuses for the file:
  • COMPLETE
  • PENDING
  • PROCESSING
processingResult Array Returns one of two result arrays:
  • success - A list of records that processed successfully, sorted by packaging code/type and by the number of serial numbers processed for each packaging code/type.
  • failed - A list of records that did not process successfully, sorted by packaging code/type and by the number of serial numbers processed for each packaging code/type.

This field displays only when the processing state is complete.

Example

{
    "t": {
       "v": 1,
       "m": "pim--producer-poll-processing-product-identifiers-response--v1",
       "app-id": "393C3176-6F7C-438D-B06F-DDCDA21C2E5C",
       "cid": ""	
    },
    "p": {
        "processingState": "COMPLETE",
        "processingResult": {
            "success": [
                {
                    "packagingCode": "10312345678910",
                    "packagingCodeType": "GTIN-14",
                    "count": 12
				}
            ],
            "failed": [
                {
                    "packagingCode": "10312345678910",
                    "packagingCodeType": "GTIN-14",
                    "count": 1,
                    "failureReason": "Expiration Date cannot be null or empty or any other format than yyyy-MM-dd"
                },
                {
                    "packagingCode": "10312345678911",
                    "packagingCodeType": "GTIN-14",
                    "count": 1,
                    "failureReason": "Unsupported Serial Number Status"
                },
                {
                    "packagingCode": "10312345678911",
                    "packagingCodeType": "GTIN-14",
                    "count": 1,
                    "failureReason": "Unsupported Item Status"
                },
                {
                    "packagingCode": "10312345678911",
                    "packagingCodeType": "GTIN-14",
                    "count": 1,
                    "failureReason": "Unsupported Attribute"
                }
            ]
        }
    }
}

Errors

See HTTP response status codes for standard error status codes.