Pages API Example Usage

Retrieves a list of pages with their properties.

Example Request

Copycurl -X GET 'https://www.venddor.com.br/api/2.0/pages'

Retrieves details of a specific page by its ID.

Path Parameters

Example Request

Copycurl -X GET 'https://www.venddor.com.br/api/2.0/pages/1'

Creates a new page in the system.

Request Fields

Response Status Codes

Example Request

Copycurl --header 'Content-type: text/plain' -X POST 'https://www.venddor.com.br/api/2.0/pages' --data-binary 'page_type=T&page=Test Page&status=H&description=<p>This is a test page to see how the API works.</p>'

This example creates a new hidden page called Test Page with the following content: "This is a test page to see how the API works.". The content uses HTML <p></p> tags.

Example Response

Copy{
  "page_id": 226
}

Updates an existing page with new properties.

Path Parameters

Available Fields

page, parent_id, status, position, timestamp, usergroup_ids, localization, new window (for links only), use_avail_period, avail_from_timestamp, avail_till_timestamp, description, meta_keywords, meta_description, page_title, link (only for links), seo_name

Example Request

Copycurl --header 'Content-type: text/plain' -X PUT 'https://www.venddor.com.br/api/2.0/pages/226' --data-binary 'status=A'

This example updates the status of the page with page_id=226 to Active.

Example Response

Copy{
  "page_id": 226
}

Deletes a specific page from the system.

Path Parameters

Response Status Codes

Example Request

Copycurl -X DELETE 'https://www.venddor.com.br/api/2.0/pages/226'

This example deletes the page with page_id=226.