Skip to main content

API Reference​

The Zip API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL
https://api.zip.ph

Test mode​

You can build and test a full API integration with Zip using test mode.

Test API keys will only interact with your test mode store data.

When you are ready to go live with your integration, make sure to use API key in live mode and use that in your production application.

Making Requests​

All API requests must be made over HTTPS to https://api.zip.ph. Calls made over plain HTTP will fail. API requests without authentication will also fail.

The Zip API accepts and returns JSON-encoded data and as such you should include the following headers in each request.

  • Content-Type: application/json
  • Accept: application/json

Resource Object Structure​

The Zip API is organized into resources represented by objects with state, configuration, and contextual properties. These objects all have unique IDs that you can use to retrieve, update, and delete them. The API also uses these IDs to link related objects together.