> For the complete documentation index, see [llms.txt](https://docs.shopgo.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shopgo.me/management-api/general.md).

# Introduction

### Requests

All requests must be in `application/json`.

With the exception of few named endpoints, all requests must include authentication headers as described in [Authentication](/management-api/authentication/using-user-api-key.md).

### Responses

All responses are in `application/json`.

Request results are indicated using the appriopriate HTTP status codes, as well as an additional `result` field. Here are two examples ...

#### Example Response (🟢 Success) 

```http
HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json
Date: Sat, 09 Jan 2021 22:00:57 GMT
Server: nginx/1.17.10 (Ubuntu)
Vary: Cookie
X-Frame-Options: SAMEORIGIN

{
    "result": "success",
    "payload": <Payload>
}
```

where `<Payload>` is a JSON object containing endpoint call results.

#### Example Response (🔴 Error)

```http
HTTP/1.1 400 Bad Request
Connection: keep-alive
Content-Type: application/json
Date: Sat, 09 Jan 2021 22:01:49 GMT
Server: nginx/1.17.10 (Ubuntu)
Vary: Cookie
X-Frame-Options: SAMEORIGIN

{
    "result": "error",
    "description": "explanation of what went wrong"
}
```