Skip to main content
POST
/
v0
/
items
Create
curl --request POST \
  --url https://api.paygentic.io/v0/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantId": "<string>",
  "name": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "object": "item",
  "merchantId": "<string>",
  "name": "<string>",
  "metadata": {},
  "externalReferences": [
    {
      "id": "<string>",
      "object": "externalReference",
      "merchantId": "<string>",
      "entityType": "item",
      "entityId": "<string>",
      "provider": "<string>",
      "externalId": "<string>",
      "metadata": {},
      "isPrimary": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "externalLabel": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json
merchantId
string
required
Pattern: ^org_[a-zA-Z0-9]+$
name
string
required

Canonical sellable name for the Item

metadata
object

Optional key-value metadata

Response

Item created

id
string
required
Pattern: ^itm_[a-zA-Z0-9]+$
object
enum<string>
default:item
required
Available options:
item
merchantId
string
required
Pattern: ^org_[a-zA-Z0-9]+$
name
string
required
metadata
object
required
externalReferences
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required