Body Envelope

Every response is contained in an envelope which means each response has a predictable set of keys with which you can interact.

---

meta

The meta key helps communicate extra information regarding a response to the developer.

meta

Key	Type	Optional?	Description	Example
code	Number		Up to a 5-digit code that represents the status of the request	200
type	String		short string, which is the name of the returned HTTP status	OK
message	String		Human-readable description of the specific meta code	The request was successfully processed by AfterShip.
errors	Error[]	✔	Detailed error information to indicate the error in the request. It only exists in error responses

Error

Key	Type	Optional?	Description	Example
code	Number	✔	A 1 to 5-digit integer that represents the status of the request	10000
path	String		Error path of the request	includeFilters
info	String		Human-readable description of the specific error	The include_filters field only supports tags, categories.

Normal Response

{
    "meta": {
      "code": 200,
      "type": "OK",
      "message": "The request was successfully processed by AfterShip."
    },
    "data": {
      ...
    }
}

Error

Data

The data key is the meat of the response. It can be in the form of a list of results, but either way, this is where you’ll find the requested data.

Here is an example for POST /discoveries/recommend

{
  "meta": {
      "code": 200,
      "type": "OK",
      "message": "The request was successfully processed by AfterShip."
  },
  "data": {
    "products": [
      {
        ...
      },
      {
        ...
      }
    ]
  }
}