Sign in

v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB
integrations

Create commerce integration

Create commerce integration metadata to link an external business ID with a Pinterest merchant & ad account. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.

post/integrations/commerce

Request body

additional_id_1string
connected_advertiser_idstring
connected_lba_idstring
connected_merchant_idstring
connected_tag_idstring
external_business_idstring

External business ID for the integration.

partner_access_tokenstring
partner_access_token_expirynumber
partner_metadatastring
partner_primary_emailstring
partner_refresh_tokenstring
partner_refresh_token_expirynumber
scopesstring

Response

The request has succeeded.

additional_id_1string
connected_advertiser_idstring
connected_lba_idstring
connected_merchant_idstring
connected_tag_idstring
connected_user_idstring
created_timestampnumber
external_business_idstring

External business ID for the integration.

idstring
partner_access_token_expirynumber
partner_metadatastring
partner_refresh_token_expirynumber
scopesstring
updated_timestampnumber

Example response

{
  "id": "7329167449607351372",
  "external_business_id": "1238401984",
  "connected_merchant_id": "1445572885401",
  "connected_user_id": "871939315263957401",
  "connected_advertiser_id": "549764738871",
  "connected_lba_id": "871939315263957402",
  "connected_tag_id": "2412141155151",
  "partner_access_token_expiry": 1621350033000,
  "partner_refresh_token_expiry": 1621350033000,
  "scopes": "accounts:read",
  "created_timestamp": 1621350033000,
  "updated_timestamp": 1621350033000,
  "additional_id_1": "128464",
  "partner_metadata": ""
}