Skip to main content
POST
Create Retailer Identifier

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the parent Retailer.

Required range: x >= 1

Body

application/json

An object conforming to the RetailerIdentifier schema to be created.

A RetailerIdentifier represents an EDI / trading-partner identifier attached to a Retailer (e.g. DUNS, GLN, SPS Trading Partner ID).

qualifier
enum<string>
required

Identifier qualifier kind.

Available options:
sps_trading_partner_id
Example:

"sps_trading_partner_id"

value
string
required

Identifier value. Must be unique within (qualifier, value) per scope — a global row and a merchant-specific row may carry the same pair.

Required string length: 1 - 64
Example:

"123456789"

label
string | null

Optional human-readable label.

Maximum string length: 128
Example:

"Primary EDI DUNS"

notes
string | null

Optional freeform notes.
Optional Field

Example:

"Created from SPS onboarding kit."

merchant
Merchant · object | null

Merchant scope of the identifier. null means the identifier is global (visible to all merchants); a merchant-specific identifier overrides a global one with the same qualifier and value. The scope may be changed on update.

retailer
RetailerRef · object

Parent Retailer reference. Set from the path; cannot be changed.

Response

Created - The resource was created successfully.

resource
object

An object describing the resource that was created.

meta
object