Share status APIs

Producers can determine whether the product master data they own is accessible to Consumers. These controls can be set by specifying the individual packaging codes or the target market that the Producer would like to make accessible in Product Information Manager.

Set Share Status

Producers use this message to set and update access controls for product master data they own and share through Product Information Manager. These controls are set by specifying the individual packaging codes.

The Set Share Status request returns a standard HTTP response status code. The response contains an empty payload.

Set Share Status request

Guidelines

Element		Type	Description
records		Array	Required. The array containing all shared packaging codes, defined as a code and type.
	active	Enum	Required. The status of the record. Valid values: `ACTIVE` — Allows any Consumers of Master Data Share to download the product master data. `INACTIVE` — Requires that the Consumer has been granted access by the Producer to download the Producer's record.
	packagingCode	Integer	Required. The serialized product's packaging code.
	packagingCodeType	Enum	Required. Indicates the type of the serialized product's associated packaging code. Valid values: `GTIN-14` `NTIN` `CN-RESCODE` `PPN`

Example

{
    "t": {
        "v": 1,
        "m": "pim--producer-set-activation-mds--v1",
        "app-id": "393C3176-6F7C-438D-B06F-DDCDA21C2E5C"
    },
    "p": {
        "records": [
            {
                "active": "ACTIVE",
                "packagingCode": "8f996821-fd3f-402a-b3cd-8c5cd32f4e1d",
                "packagingCodeType": "GTIN-14"
            }
        ]
    }		
}

Set Market Share Status

Producers use this call to set and update access controls for product master data they own and share through Product Information Manager. The Producer specifies the share status of each target market present in the request.

The Set Market Share request returns a standard HTTP response status code. The response contains an empty payload.

Set Market Share request

Guidelines

Element		Type	Description
records		Array	Required. The array containing all shared packaging codes, defined as a code and type.
	active	Enum	Required. The status of the record. Valid values: `ACTIVE` — Allows any Consumers of Master Data Share to download the product master data. `INACTIVE` — Requires that the Consumer has been granted access by the Producer to download the Producer's record.
	packagingCode	Integer	Required. The serialized product's packaging code.
	packagingCodeType	Enum	Required. Indicates the type of the serialized product's associated packaging code. Valid values: `GTIN-14` `NTIN` `CN-RESCODE` `PPN`
	targetMarketCountryCodes	Enum	Required. The Target Market country code. See Country Code for valid values.

Example

{
    "t": {
        "v": 1,
        "m": "pim--producer-set-sharing-mds--v1",
        "app-id": "393C3176-6F7C-438D-B06F-DDCDA21C2E5C"
    },
    "p": {
        "records": [
            {
                "shareStatus": "SHARED",
                "packagingCode": "09374859283647",
                "packagingCodeType": "GTIN-14",
                "targetMarketCountryCodes": [
                    "US"
                ]
            }
        ]
    }		
}