# 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"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shopgo.me/management-api/general.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.