ad_accounts14

ad_groups13

ads10

advanced_auction2

audience_insights2

audience_sharing7

audiences4

billing11

boards11

bulk3

business_access_assets12

business_access_invite6

business_access_relationships9

campaigns8

catalog_feeds8

catalog_items3

catalog_product_groups10

catalog_reports3

catalog_supplemental7

catalogs3

conversion_deletion_requests4

conversion_eqs1

conversion_events1

conversion_tags5

conversions4

customer_list_uploads3

customer_lists4

customer_segment3

integrations7

keywords5

labels5

lead_ads4

lead_forms5

leads_export2

media3

msot_events1

notification1

oauth3

order_lines2

pins8

product_group_promotions5

product_tags3

promotions5

resources6

schedules3

search3

targeting_template3

terms2

terms_of_service1

trends4

user_account14

integrations

Create commerce integration

Changed on Jun 4, 2026

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

Base URL
https://api.pinterest.com/v5
Auth
OAuth 2
Authorization codehttps://www.pinterest.com/oauth/
Token URLhttps://api.pinterest.com/v5/oauth/token
Scopesads:write
TypeScript
https://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/integrations/commerce/post.ts
A function with typed inputs. Its response is checked against the schema.

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": ""
}

Changes

Jun 4, 2026v5b698c180678a Revision changes
- breaking
  the response's property type changed from string to no type for status
- info
  the request property type was generalized from integer to number
- info
  the request property type was generalized from integer to number
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  removed the non-success response with the status
- info
  the response optional property became not read-only for the status
- info
  the response optional property became read-only for the status
- info
  the response optional property became read-only for the status
- info
  the response optional property became read-only for the status
- info
  added to the response property allOf list for the response status
- info
  the response's property pattern ^\d+$ was removed for the status
- info
  added the success response with the status
Dec 11, 2025v579f62f71f05b Revision changes
- breaking
  request body became required

Operation history (6 revisions)