Product Catalogs
product-catalogs

Product Catalogs

Run in Postman ❯ 

These endpoints are currently available via early-access only. To apply for access, please fill out this form.

GET product_catalogs

Retrieve details for some or all product catalogs associated with the authenticated user (default) or the user specified in the user_id parameter.

Resource URL

https://ads-api.x.com/12/product_catalogs

Request Parameter

Name Description
user_id

A reference to the user you are operating with in the request. Use GET users/lookup to retrieve a user ID for a screen name.

Type: long

Example: 756201191646691328

Example Request

GET https://ads-api.x.com/12/product_catalogs

Example Response

{
  "request": {
    "params": {}
  },
  "next_cursor": null,
  "data": [
    {
      "id": "1547080201384865792",
      "name": "Catalog Name"
    }
  ]
}

     

POST product_catalogs

Creating a product catalog. One user can only create one catalog that holds all products. Twitter merchants need to create a catalog before uploading products.

Request Parameters

Name Description
name
required

Name of your product catalog

Type: string

Example: My Product Catalog
user_id
optional

A reference to the user you are operating with in the request. Use GET users/lookup to retrieve a user ID for a screen name.

Type: long

Example: 756201191646691328

Example Request

POST https://ads-api.x.com/12/product_catalogs?name=catalog_123_abc_def

Example Response

{
  "request": {
    "params": {
      "name": "catalog_123_abc_def"
    }
  },
  "data": {
    "id": "1559934724822351872",
    "name": "catalog_123_abc_def"
  }
}

     

PUT product_catalogs/:product_catalog_id

Updating a product catalog

Request Parameters

Name Description
id
required

Identifier of your product catalog

Type: string

Example: 1547080201384865792
name
required

Name of your product catalog

Type: string

Example: My Product Catalog

Example Request

PUT https://ads-api.x.com/12/product_catalogs/1547080201384865792?name=My Catalog

Example Response

{
  "request": {
    "params": {
      "id": "1547080201384865792",
      "name": "My Catalog"
    }
  },
  "data": {
    "id": "1547080201384865792",
    "name": "My Catalog"
  }
}

    

DELETE product_catalogs/:product_catalog_id

Deleting a product catalog. Please note that this is a permanent deletion.

Request Parameters

Name Description
id
required

Identifier of your product catalog

Type: string

Example: 1547080201384865792

Example Request

DELETE https://ads-api.x.com/12/product_catalogs/1559919496399204352

Example Response

{
  "request": {
    "params": {
      "id": "1559919496399204352"
    }
  },
  "data": {
    "id": "1559919496399204352",
    "name": "catalog dos"
  }
}