### Example URL for Filtering and Sorting Orders

Source: https://developer.apilo.com/api

This example URL demonstrates how to filter and sort a list of orders. It includes parameters for order status, creation date, and sorting by update time in descending order.

```text
/rest/api/orders/?orderStatus=7&createdAfter=2022-03-01T14%3A40%3A33%2B0200&order&sort=updatedAtDesc
```

--------------------------------

### Response Example

Source: https://developer.apilo.com/api

Example of a successful response when retrieving order details, containing the order ID.

```APIDOC
## Response Example (200 OK)

### Content Type
application/json

### Response Body
```json
{
  "id": "AA123456789"
}
```
```

--------------------------------

### Request Payload Example

Source: https://developer.apilo.com/api

Example of a JSON payload for creating or updating an order, including details about the platform, customer, payment, items, and addresses.

```APIDOC
## Request Body Example

### Content Type
application/json

### Payload
```json
{
  "platformId": 1,
  "idExternal": "WWW/341/2023",
  "isInvoice": true,
  "customerLogin": "user123",
  "paymentStatus": 2,
  "paymentType": 2,
  "originalCurrency": "PLN",
  "originalAmountTotalWithoutTax": 1024.37,
  "originalAmountTotalWithTax": 1259.98,
  "originalAmountTotalPaid": 1259.98,
  "sendDateMin": "2022-03-07T00:00:00Z",
  "sendDateMax": "2022-03-08T20:00:00Z",
  "preferences": {
    "idUser": "user-12345"
  },
  "orderItems": [
    {
      "id": 1,
      "idExternal": "359",
      "ean": "400638133393",
      "sku": "P44/3-T1.2",
      "originalName": "Samsung Galaxy S20 Plus Black 128GB 5G",
      "originalCode": "PHONE-S20-128GB-B",
      "originalPriceWithTax": "2799.99",
      "originalPriceWithoutTax": "2799.99",
      "media": null,
      "quantity": 2,
      "tax": "23.00",
      "productSet": null,
      "status": 1,
      "unit": "Szt.",
      "type": 1,
      "productId": 12345
    },
    {
      "id": 2,
      "idExternal": null,
      "ean": null,
      "sku": "ship-pp",
      "originalName": "Wysyłka - Poczta Polska - Pocztex",
      "originalCode": null,
      "originalPriceWithTax": "10.00",
      "originalPriceWithoutTax": "10.00",
      "media": null,
      "quantity": 1,
      "tax": null,
      "productSet": null,
      "status": 1,
      "unit": null,
      "type": 2,
      "productId": null
    }
  ],
  "orderPayments": [
    {
      "idExternal": "PAY-123456",
      "amount": 1259.98,
      "paymentDate": "2022-03-08T20:00:00Z",
      "type": 1,
      "comment": "Komentarz do wpłaty"
    }
  ],
  "addressCustomer": {
    "name": "Jan Kowalski",
    "phone": "+48 500 000 000",
    "email": "jan.kowalski@apilo.com",
    "streetName": "Testowa",
    "streetNumber": "4b/12",
    "city": "Kraków",
    "zipCode": "31-154",
    "country": "PL",
    "parcelIdExternal": "KRA32B",
    "parcelName": "Paczkomat, ul. Testowa 12 (obok sklepu)",
    "companyTaxNumber": "937-271-51-54",
    "companyName": "Apilo Sp. z o.o."
  },
  "addressDelivery": {
    "name": "Jan Kowalski",
    "phone": "+48 500 000 000",
    "email": "jan.kowalski@apilo.com",
    "streetName": "Testowa",
    "streetNumber": "4b/12",
    "city": "Kraków",
    "zipCode": "31-154",
    "country": "PL",
    "parcelIdExternal": "KRA32B",
    "parcelName": "Paczkomat, ul. Testowa 12 (obok sklepu)",
    "companyTaxNumber": "937-271-51-54",
    "companyName": "Apilo Sp. z o.o."
  },
  "addressInvoice": {
    "name": "Jan Kowalski",
    "phone": "+48 500 000 000",
    "email": "jan.kowalski@apilo.com",
    "streetName": "Testowa",
    "streetNumber": "4b/12",
    "city": "Kraków",
    "zipCode": "31-154",
    "country": "PL",
    "parcelIdExternal": "KRA32B",
    "parcelName": "Paczkomat, ul. Testowa 12 (obok sklepu)",
    "companyTaxNumber": "937-271-51-54",
    "companyName": "Apilo Sp. z o.o."
  },
  "carrierAccount": 1,
  "orderNotes": [
    {
      "type": 2,
      "comment": "I'll ask for delivery next week at the earliest"
    }
  ],
  "orderedAt": "2022-06-09T10:59:12+0100",
  "status": 3
}
```
```

--------------------------------

### Shipment Response Sample

Source: https://developer.apilo.com/api

Example response when a shipment is successfully added to an order.

```json
{
  "id": 1,
  "idExternal": "312",
  "tracking": "005842792564T",
  "carrierProviderId": 1,
  "postDate": "2022-06-09T10:59:12+0100",
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc",
  "status": 2

}
```

--------------------------------

### Get Platform list.

Source: https://developer.apilo.com/api

Retrieves a list of platforms. Requires Bearer authentication.

```APIDOC
## Get Platform list.

### Description
Retrieves a list of Platform objects.

### Method
GET

### Endpoint
/rest/api/orders/platform/map/

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
Returns list of Platform objects.

#### Response Example
```json
[
  {
    "id": 44,
    "key": "PLATFORM_ALLEGRO_44",
    "name": "Allegro",
    "description": "Allegro jankowalski"
  }
]
```

#### Error Response (401)
Authorization failed.
```

--------------------------------

### Get Product Media

Source: https://developer.apilo.com/api

Retrieves a list of product media with filtering and pagination options.

```APIDOC
## GET /rest/api/warehouse/product/media/

### Description
Retrieves a list of product media.

### Method
GET

### Endpoint
/rest/api/warehouse/product/media/

### Parameters
#### Query Parameters
- **onlyMain** (boolean) - Optional - Filters for main media.
- **productIds[]** (Array of integers) - Optional - Filters by product IDs.
- **offset** (integer) - Optional - Position indicator for pagination. Minimum value is 0.
- **limit** (integer) - Optional - Limit of returned results. Maximum value is 512.

### Response
#### Success Response (200)
- **media** (array) - List of product media objects.
  - **id** (integer) - Media ID.
  - **isMain** (boolean) - Indicates if this is the main media.
  - **productId** (integer) - The ID of the product this media belongs to.
  - **uuid** (string) - Unique identifier for the media.
  - **extension** (string) - File extension of the media.
  - **link** (string) - URL to the media.
- **totalCount** (integer) - Total number of media items available.
- **currentOffset** (integer) - The current offset for pagination.
- **pageResultCount** (integer) - The number of results in the current page.

#### Response Example (200)
{
  "media": [
    {
      "id": 0,
      "isMain": true,
      "productId": 0,
      "uuid": "string",
      "extension": "string",
      "link": "string"
    }
  ],
  "totalCount": 7398,
  "currentOffset": 0,
  "pageResultCount": 64
}
```

--------------------------------

### Get Location Detail Response Sample

Source: https://developer.apilo.com/api

Sample response for retrieving detailed location information.

```json
{
  * "id": 341,
  * "name": "Column A",
  * "code": "A.001.B.002"
}
```

--------------------------------

### Get Products List

Source: https://developer.apilo.com/api

Retrieves a list of products with various filtering options.

```APIDOC
## GET /rest/api/warehouse/product/

### Description
Retrieves a simple list of products.

### Method
GET

### Endpoint
/rest/api/warehouse/product/

### Parameters
#### Query Parameters
- **id** (integer) - Optional - Product ID.
- **sku** (string) - Optional - Product SKU.
- **name** (string) - Optional - Product name.
- **ean** (string) - Optional - Product EAN.
- **status** (any Enum) - Optional - Product status (`0-inactive`, `1-active`, `8-archive`).
- **offset** (integer) - Optional - Position indicator for pagination. Maximum value is 2000 records.
- **limit** (integer) - Optional - Limit of returned results.

### Response
#### Success Response (200)
- **products** (array) - List of product objects.
  - **name** (string) - Product name.
  - **unit** (string) - Product unit.
  - **weight** (number) - Product weight.
  - **priceWithoutTax** (number) - Price without tax.
  - **sku** (string) - Product SKU.
  - **ean** (string) - Product EAN.
  - **id** (integer) - Product ID.
  - **originalCode** (string) - Original product code.
  - **quantity** (integer) - Product quantity.
  - **priceWithTax** (number) - Price with tax.
  - **tax** (string) - Tax amount.
  - **status** (integer) - Product status.
  - **location** (string) - Product location.
- **totalCount** (integer) - Total number of products available.

#### Response Example (200)
{
  "products": [
    {
      "name": "Samsung Galxy S20 Plus Black 128GB",
      "unit": "string",
      "weight": 1.12,
      "priceWithoutTax": 100,
      "sku": "HG-331/P",
      "ean": "4006381333931",
      "id": 1234,
      "originalCode": "p12345",
      "quantity": 15,
      "priceWithTax": 123,
      "tax": "23.00",
      "status": 1,
      "location": "A.001.B.002"
    }
  ],
  "totalCount": 0
}
```

--------------------------------

### Get list of sales channels

Source: https://developer.apilo.com/api

Retrieves a list of available sales channels.

```APIDOC
## Get list of sales channels.

### Description
Retrieves a list of available sales channels.

### Method
GET

### Endpoint
/rest/api/sale/

### Responses
#### Success Response (200)
Return list of sales channels.

#### Error Response (401)
Authorization failed.
```

--------------------------------

### Get auctions list

Source: https://developer.apilo.com/api

Retrieves a list of auctions.

```APIDOC
## Get auctions list.

### Description
Retrieves a list of auctions.

### Method
GET

### Endpoint
/rest/api/sale/auction/

### Responses
#### Success Response (200)
Returns list of auctions.

#### Error Response (401)
Authorization failed.
```

--------------------------------

### Response Sample: Get Order Notes

Source: https://developer.apilo.com/api

This JSON represents a sample response when retrieving order notes, including the note type, creation timestamp, and comment.

```json
{
  "type": 2,
  "createdAt": "2024-01-23T09:29:30+0100",
  "comment": "I'll ask for delivery next week at the earliest"

}
```

--------------------------------

### Get Categories List

Source: https://developer.apilo.com/api

Retrieves a simple list of categories with pagination options.

```APIDOC
## GET /rest/api/warehouse/category/

### Description
Retrieves a simple list of categories.

### Method
GET

### Endpoint
/rest/api/warehouse/category/

### Parameters
#### Query Parameters
- **id** (integer) - Optional - Internal Apilo ID for category.
- **offset** (integer) - Optional - Position indicator for pagination. Minimum value is 0.
- **limit** (integer) - Optional - Limit of returned results. Maximum value is 512.

### Response
#### Success Response (200)
- **categories** (array) - List of category objects.
  - **id** (string) - Category ID.
  - **name** (string) - Category name.
  - **parentIds** (array) - List of parent category IDs.
- **totalCount** (integer) - Total number of categories available.
- **currentOffset** (integer) - The current offset for pagination.
- **pageResultCount** (integer) - The number of results in the current page.

#### Response Example (200)
{
  "categories": [
    {
      "id": "1",
      "name": "Category name",
      "parentIds": [
        1,
        2
      ]
    }
  ],
  "totalCount": 7398,
  "currentOffset": 0,
  "pageResultCount": 64
}
```

--------------------------------

### Get order notes.

Source: https://developer.apilo.com/api

Retrieves notes for a specific order. Requires Bearer authentication.

```APIDOC
## Get order notes.

### Description
Retrieves a list of notes for a specific order.

### Method
GET

### Endpoint
/rest/api/orders/{id}/note/

### Parameters
#### Path Parameters
- **id** (string) - Required - Order number in Apilo system, e.g. `AL0012345`. Must be between 10 and 11 characters and match the regex `^[A-Za-z0-9\.|]{10,11}$`.

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
List of order notes.

#### Response Example
```json
{
  "type": 2,
  "createdAt": "2024-01-23T09:29:30+0100",
  "comment": "I'll ask for delivery next week at the earliest"
}
```

#### Error Response (401)
Authorization failed.

#### Error Response (404)
Invalid platform ID.
```

--------------------------------

### Get Order Tags

Source: https://developer.apilo.com/api

Retrieves a list of tags associated with a specific order. Supports pagination.

```json
{
  "list": [
    {
      "id": "1",
      "alias": "aliasExample",
      "name": "name",
      "color": "blue"
}
],
  "pageResultCount": "1",
  "totalCount": "512",
  "currentOffset": "0"

}
```

--------------------------------

### Get Payment Types List Response (200)

Source: https://developer.apilo.com/api

Sample JSON response for the payment types list. This provides a list of available payment types with their IDs, keys, names, and descriptions.

```json
[
  {
    "id": 1,
    "key": "PAYMENT_TYPE_BANK_TRANSFER",
    "name": "Przelew bankowy",
    "description": "przelew bankowy"
},
  {
    "id": 2,
    "key": "PAYMENT_TYPE_COD",
    "name": "Pobranie",
    "description": "za pobraniem"
},
  {
    "id": 3,
    "key": "PAYMENT_TYPE_SERVICE_PAYU",
    "name": "PayU",
    "description": "serwis PayU"
}

]
```

--------------------------------

### Get simple list of orders

Source: https://developer.apilo.com/api

Retrieves a simple list of orders, with options for filtering and sorting.

```APIDOC
## GET /rest/api/orders/

### Description
Retrieves a simple list of orders, with options for filtering and sorting. The fields orderItems and addressCustomer will be returned conditionally from end of 2022.

### Method
GET

### Endpoint
/rest/api/orders/

### Query Parameters
- **orderStatus** (string) - Optional - Example: 7
- **createdAfter** (string) - Optional - Example: 2022-03-01T14%3A40%3A33%2B0200
- **sort** (string) - Optional - Example: updatedAtDesc
```

--------------------------------

### Get Document Types Map Response (200)

Source: https://developer.apilo.com/api

Sample JSON response for the document types map. This provides a list of available document types with their IDs, keys, names, and descriptions.

```json
[
  {
    "id": 2,
    "key": "E_INVOICE",
    "name": "Faktura sprzedaży",
    "description": "Faktura sprzedaży",
    "isBroker": null
}

]
```

--------------------------------

### Response Sample: Platform List

Source: https://developer.apilo.com/api

This JSON illustrates a sample response for a platform list, including platform ID, key, name, and description.

```json
[
  {
    "id": 44,
    "key": "PLATFORM_ALLEGRO_44",
    "name": "Allegro",
    "description": "Allegro jankowalski"
  },
  {
    "id": 92,
    "key": "PLATFORM_AMAZON_92",
    "name": "Amazon",
    "description": "Amazon 4x kowalski janek"
  },
  {
    "id": 101,
    "key": "PLATFORM_EMPIK_101",
    "name": "Empik",
    "description": "Empik jan.kowalski@apilo.com"
  }

]
```

--------------------------------

### Product Media Response Sample

Source: https://developer.apilo.com/api

This is a sample JSON response for retrieving product media. It includes details such as media ID, product ID, file extension, and download link.

```json
{
  "media": [
    {
      "id": 0,
      "isMain": true,
      "productId": 0,
      "uuid": "string",
      "extension": "string",
      "link": "string"
}
],
  "totalCount": 7398,
  "currentOffset": 0,
  "pageResultCount": 64
}
```

--------------------------------

### Prices List Response Sample

Source: https://developer.apilo.com/api

Sample response for listing prices, including price details and total count.

```json
{
  * "list": [
    * {
      * "id": 1,
      * "price": 12,
      * "product": 3,
      * "customPriceWithTax": 14.9,
      * "customPriceModify": 10,
      * "customMode": 7
}
],
  * "totalCount": 0
}
```

--------------------------------

### Get Order Default Shipping Settings Response

Source: https://developer.apilo.com/api

This JSON object shows the default shipping settings for an order, including carrier account and method. It is returned by the GET /rest/api/orders/{id}/shipping-settings-defaults/ endpoint.

```json
{
  "mappedDelivery": {
    "carrierAccountId": "1",
    "carrierMethod": "parcel_locker",
    "_help": {
      "message": "You can change delivery mapping for this platform by visiting provided link.",
      "href": "https://client1000.apilo.com/admin/platform-account/mapping/1/1/"
    }
  }
}
```

--------------------------------

### Product Response Sample

Source: https://developer.apilo.com/api

This is a sample JSON response for a product, detailing its attributes like name, group, categories, pricing, and stock information.

```json
{
  "name": "BLACK 128GB",
  "groupName": "Samsung Galxy S20 Plus",
  "productGroupId": 123456,
  "categories": [
    12,
    44,
    149
  ],
  "unit": "string",
  "weight": 1.12,
  "priceWithoutTax": 100,
  "sku": "HG-331/P",
  "ean": "4006381333931",
  "id": 1234,
  "originalCode": "p12345",
  "quantity": 15,
  "priceWithTax": 123,
  "tax": "23.00",
  "status": 1,
  "location": "A.001.B.002"
}
```

--------------------------------

### Get Carrier Account List

Source: https://developer.apilo.com/api

Retrieves a list of all available carrier accounts.

```APIDOC
## GET /rest/api/shipping/carrier-account/map/

### Description
Returns a list of carrier accounts.

### Method
GET

### Endpoint
/rest/api/shipping/carrier-account/map/

### Response
#### Success Response (200)
Returns list of Carrier Account

#### Response Example
{
  "carrierAccounts": [
    {
      "id": "3",
      "key": "CARRIER_253",
      "name": "Inpost (Kurier, Paczkomaty, Allegro)",
      "description": "Kurier",
      "options": {
        "isPickupInShipmentCreation": true,
        "isPickupInShipmentConfirmation": true,
        "isShipmentConfirmationRequired": true
      }
    }
  ]
}
```

--------------------------------

### Price Lists Response Sample

Source: https://developer.apilo.com/api

Sample response for listing available price lists, including pagination details.

```json
{
  * "list": [
    * {
      * "id": 1,
      * "name": "Cennik"
}
],
  * "totalCount": 7398,
  * "currentOffset": 0,
  * "pageResultCount": 64
}
```

--------------------------------

### Create/Update Price Response Sample

Source: https://developer.apilo.com/api

Sample response after creating or updating a price, indicating the new ID.

```json
{
  * "id": 0
}
```

--------------------------------

### Get List of Shipments

Source: https://developer.apilo.com/api

Retrieves a list of shipments based on specified filters.

```APIDOC
## Get List of Shipments

### Description
Retrieves a list of shipments based on provided filter criteria.

### Method
GET

### Endpoint
/rest/api/shipping/shipment/info/

### Parameters
#### Query Parameters
- **carrierAccountId[]** (array of integers) - Optional - Carrier account IDs to filter by.
- **carrierBrokerId[]** (array of integers) - Optional - Carrier broker IDs to filter by.
- **postDateAfter** (string, date-time) - Optional - Filter shipments posted after this date (ISO 8601 format, e.g., `2022-03-01T14:40:33%2B0200`).
- **postDateBefore** (string, date-time) - Optional - Filter shipments posted before this date (ISO 8601 format, e.g., `2022-03-01T14:40:33%2B0200`).
- **status[]** (array of integers) - Optional - Status of shipment. Possible values: 0 (New parcel, not yet shipped), 1 (Parcel waiting, not sent), 2 (New parcel, registered, no status yet), 21 (Package in delivery), 9 (Package removed), 31 (Parcel waiting for collection), 32 (Return parcel to sender, other error), 100 (Parcel received), 101 (Return parcel delivered).

### Responses
#### Success Response (200)
- **shipments** (array) - A list of shipment objects.
  - **id** (string) - Shipment ID.
  - **carrierAccountId** (string) - Carrier account ID.
  - **carrierBrokerId** (string) - Carrier broker ID.
  - **externalId** (string) - External ID of the shipment.
  - **orderId** (string) - Order ID.
  - **createdAt** (string) - Creation date and time.
  - **postDate** (string) - Posting date and time.
  - **status** (integer) - Shipment status code.
  - **method** (string) - Shipping method.
  - **media** (string) - UUID of the associated media attachment.
- **totalCount** (integer) - Total number of shipments matching the filters.
- **currentOffset** (integer) - The current offset for pagination.
- **pageResultCount** (integer) - The number of results on the current page.

#### Error Responses
- **401** - Authorization failed

### Response Example (200)
```json
{
  "shipments": [
    {
      "id": "123",
      "carrierAccountId": "123",
      "carrierBrokerId": "123",
      "externalId": "312",
      "orderId": "123",
      "createdAt": "2023-11-24T08:33:07+0100",
      "postDate": "2022-06-09T10:59:12+0100",
      "status": 2,
      "method": "312",
      "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc"
    }
  ],
  "totalCount": 7398,
  "currentOffset": 0,
  "pageResultCount": 64
}
```
```

--------------------------------

### Get Media Attachment

Source: https://developer.apilo.com/api

Retrieves a media attachment by its unique identifier (UUID).

```APIDOC
## Get Media Attachment

### Description
Retrieves a media attachment using its unique UUID.

### Method
GET

### Endpoint
/rest/api/media/{uuid}/

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The UUID of the media attachment to retrieve.

### Responses
#### Success Response (200)
- **Binary Content** - The content of the media attachment.

#### Error Responses
- **401** - Authorization failed
- **404** - Media not found

### Response Example (Error)
```json
{
  "message": "string",
  "code": 0,
  "description": "string",
  "errors": [
    {}
  ],
  "field": "string"
}
```
```

--------------------------------

### Products List Response Sample

Source: https://developer.apilo.com/api

This JSON sample shows the response structure for retrieving a list of products. It includes product details such as name, SKU, EAN, price, and status.

```json
{
  "products": [
    {
      "name": "Samsung Galxy S20 Plus Black 128GB",
      "unit": "string",
      "weight": 1.12,
      "priceWithoutTax": 100,
      "sku": "HG-331/P",
      "ean": "4006381333931",
      "id": 1234,
      "originalCode": "p12345",
      "quantity": 15,
      "priceWithTax": 123,
      "tax": "23.00",
      "status": 1,
      "location": "A.001.B.002"
}
],
  "totalCount": 0

}
```

--------------------------------

### Response Sample: Tag List

Source: https://developer.apilo.com/api

This JSON shows a sample response for a tag list, containing tag ID, key, name, and description.

```json
[
  {
    "id": 9,
    "key": "TAG_9",
    "name": "BezFV",
    "description": "Bez faktury, kolor: purple-soft"
  },
  {
    "id": 5,
    "key": "TAG_5",
    "name": "DR",
    "description": "Do realizacji, kolor: purple-studio"
  },
  {
    "id": 8,
    "key": "TAG_8",
    "name": "FV",
    "description": "Klient chce fakturę, kolor: yellow-mint"
  }

]
```

--------------------------------

### Create/Update Price Request Payload Sample

Source: https://developer.apilo.com/api

Sample JSON payload for creating or updating a product price.

```json
{
  * "product": 11,
  * "price": 12,
  * "customPriceModify": 11.12,
  * "customMode": 3
}
```

--------------------------------

### Get Location detail

Source: https://developer.apilo.com/api

Retrieves detailed information about a specific location using its ID.

```APIDOC
## Get Location detail.

### Description
Retrieves detailed information about a specific location using its ID.

### Method
GET

### Endpoint
/rest/api/warehouse/location/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the location.

### Responses
#### Success Response (200)
Returns detailed Location object.

#### Error Response (401)
Authorization failed.

#### Error Response (404)
Location not found.
```

--------------------------------

### Shipments List Response Sample

Source: https://developer.apilo.com/api

Sample JSON response for a list of shipments, including details like ID, status, and creation date. Also shows pagination information.

```json
{
  "shipments": [
    {
      "id": "123",
      "carrierAccountId": "123",
      "carrierBrokerId": "123",
      "externalId": "312",
      "orderId": "123",
      "createdAt": "2023-11-24T08:33:07+0100",
      "postDate": "2022-06-09T10:59:12+0100",
      "status": 2,
      "method": "312",
      "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc"
}
],
  "totalCount": 7398,
  "currentOffset": 0,
  "pageResultCount": 64
}
```

--------------------------------

### Create Media Attachment Response Sample

Source: https://developer.apilo.com/api

Sample JSON response for successfully creating a media attachment. Includes UUID, name, type, and expiration.

```json
{
  "uuid": "2ed996a6-0b91-529c-9728-f2e59532e7bc",
  "name": "Invoice-22-12-2020.pdf",
  "type": "application/pdf",
  "expiresAt": "2022-03-08T20:00:00Z"
}
```

--------------------------------

### Get Shipment Detail

Source: https://developer.apilo.com/api

Retrieves the details of a specific shipment belonging to a given order.

```APIDOC
## GET /rest/api/orders/{id}/shipment/{shipment}/

### Description
Retrieves detailed information about a specific shipment associated with an order.

### Method
GET

### Endpoint
/rest/api/orders/{id}/shipment/{shipment}/

### Parameters
#### Path Parameters
- **id** (string) - Required - Order number in Apilo system, e.g. `AL0012345`. Must be 10 to 11 characters long and match the regex `^[A-Za-z0-9\.|]{10,11}$`.
- **shipment** (string) - Required - ID of the shipment belonging to the Apilo order.

### Responses
#### Success Response (200)
- Shipment model details.

#### Error Response (401)
- Authorization failed.

#### Error Response (404)
- Document or Order not found.

### Response Example (200)
```json
{
  "id": 1,
  "idExternal": "312",
  "tracking": "005842792564T",
  "carrierProviderId": 1,
  "postDate": "2022-06-09T10:59:12+0100",
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc",
  "status": 2
}
```
```

--------------------------------

### Response Sample: Carrier Account List

Source: https://developer.apilo.com/api

This JSON provides a sample response for a carrier account list, detailing account ID, key, name, and description.

```json
[
  {
    "id": 22,
    "key": "CARRIER_ACCOUNT_143_22",
    "name": "AllegroBroker Minipaczka",
    "description": "Wysyłam z Allegro"
  },
  {
    "id": 23,
    "key": "CARRIER_ACCOUNT_143_23",
    "name": "DPD PL - nowa umowa",
    "description": "DPD Polska"
  },
  {
    "id": 15,
    "key": "CARRIER_ACCOUNT_3_15",
    "name": "Inpost",
    "description": "Inpost (Kurier, Paczkomaty, Allegro"
  }

]
```

--------------------------------

### Response Sample: Carrier List

Source: https://developer.apilo.com/api

This JSON shows a sample response for a carrier list, including carrier ID, key, name, and description.

```json
[
  {
    "id": 3,
    "key": "CARRIER_253",
    "name": "Inpost (Kurier, Paczkomaty, Allegro)",
    "description": ""
  },
  {
    "id": 143,
    "key": "CARRIER_258",
    "name": "Wysyłam z Allegro",
    "description": ""
  },
  {
    "id": 5,
    "key": "CARRIER_257",
    "name": "Poczta Polska",
    "description": ""
  }

]
```

--------------------------------

### Get list of Carrier.

Source: https://developer.apilo.com/api

Retrieves a list of available carriers. Requires Bearer authentication.

```APIDOC
## Get list of Carrier.

### Description
Retrieves a list of Carrier objects.

### Method
GET

### Endpoint
/rest/api/orders/carrier/map/

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
Returns list of Carrier objects.

#### Response Example
```json
[
  {
    "id": 3,
    "key": "CARRIER_253",
    "name": "Inpost (Kurier, Paczkomaty, Allegro)",
    "description": ""
  }
]
```

#### Error Response (401)
Authorization failed.
```

--------------------------------

### Get Carrier Sending Methods

Source: https://developer.apilo.com/api

Retrieves a list of sending methods for a specific carrier account.

```APIDOC
## GET /rest/api/shipping/carrier-account/{id}/method/

### Description
Returns a list of sending methods for a given carrier account.

### Method
GET

### Endpoint
/rest/api/shipping/carrier-account/{id}/method/

### Parameters
#### Path Parameters
- **id** (string) - Required - Carrier Account ID

### Response
#### Success Response (200)
Returns list of Carrier Account sending methods

#### Response Example
{
  "methods": [
    {
      "id": "parcel_locker",
      "name": "Nadanie w paczkomacie"
    }
  ]
}
```

--------------------------------

### Get Detailed Shipment by ID

Source: https://developer.apilo.com/api

Retrieves detailed information about a specific shipment using its ID.

```APIDOC
## Get Detailed Shipment by ID

### Description
Fetches detailed information for a specific shipment identified by its ID.

### Method
GET

### Endpoint
/rest/api/shipping/shipment/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the shipment to retrieve.

### Responses
#### Success Response (200)
- **statusDate** (string) - The date and time the status was updated.
- **statusDescription** (string) - A description of the shipment's current status.
- **statusCheckTimestamp** (string) - The timestamp when the status was checked.
- **receivedDate** (string) - The date the shipment was received.
- **receivedDays** (integer) - The number of days it took for the shipment to be received.
- **id** (string) - The shipment ID.
- **carrierAccountId** (string) - The carrier account ID.
- **carrierBrokerId** (string) - The carrier broker ID.
- **externalId** (string) - The external ID of the shipment.
- **orderId** (string) - The order ID associated with the shipment.
- **createdAt** (string) - The creation date and time of the shipment record.
- **postDate** (string) - The date and time the shipment was posted.
- **status** (integer) - The status code of the shipment.
- **method** (string) - The shipping method used.
- **media** (string) - The UUID of the associated media attachment.

#### Error Responses
- **401** - Authorization failed
- **404** - Shipment not found

### Response Example (200)
```json
{
  "statusDate": "2023-11-24T08:33:07+0100",
  "statusDescription": "readyToSend",
  "statusCheckTimestamp": "2023-11-24T08:33:07+0100",
  "receivedDate": "2023-11-24T08:33:07+0100",
  "receivedDays": 2,
  "id": "123",
  "carrierAccountId": "123",
  "carrierBrokerId": "123",
  "externalId": "312",
  "orderId": "123",
  "createdAt": "2023-11-24T08:33:07+0100",
  "postDate": "2022-06-09T10:59:12+0100",
  "status": 2,
  "method": "312",
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc"
}
```
```

--------------------------------

### Create Order Document Response (200/201)

Source: https://developer.apilo.com/api

Sample JSON response for a successfully created or existing order document. Includes details of the created document and its creation timestamp.

```json
{
  "id": 1,
  "idExternal": "1",
  "number": "FV/1/12/2020",
  "priceWithTax": "123.00",
  "priceWithoutTax": "100.00",
  "currency": "PLN",
  "currencyValue": "1.000",
  "type": 16,
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc",
  "createdAt": "2023-11-24TT08:33:07+0100"
}
```

--------------------------------

### Get Order Tags

Source: https://developer.apilo.com/api

Retrieves a list of tags associated with a specific order. Supports pagination.

```APIDOC
## GET /rest/api/orders/{orderId}/tag/

### Description
Retrieves a list of tags for a given order ID. This endpoint supports pagination.

### Method
GET

### Endpoint
/rest/api/orders/{orderId}/tag/

### Parameters
#### Path Parameters
- **orderId** (string) - Required - Order ID.

#### Query Parameters
- **offset** (integer) - Optional - Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records). Must be >= 0.
- **limit** (integer) - Optional - Limit of returned results, max 512 records. Must be between 1 and 512.

### Responses
#### Success Response (200)
- Returns list of order tags.

#### Error Response (401)
- Authorization failed.

#### Error Response (404)
- Order not found.

### Response Example (200)
```json
{
  "list": [
    {
      "id": "1",
      "alias": "aliasExample",
      "name": "name",
      "color": "blue"
    }
  ],
  "pageResultCount": "1",
  "totalCount": "512",
  "currentOffset": "0"
}
```
```

--------------------------------

### Response Sample: Status List

Source: https://developer.apilo.com/api

This JSON represents a sample response for a status list, containing id, key, name, and description for each status.

```json
[
  {
    "id": 7,
    "key": "STATUS_7",
    "name": "Nowy",
    "description": "Nowy"
  },
  {
    "id": 8,
    "key": "STATUS_8",
    "name": "Niepotwierdzone",
    "description": "Niepotwierdzone"
  },
  {
    "id": 9,
    "key": "STATUS_9",
    "name": "W realizacji",
    "description": "W realizacji"
  }

]
```

--------------------------------

### Price create and update

Source: https://developer.apilo.com/api

Creates or updates a product price with specified details.

```APIDOC
## Price create and update.

### Description
Creates or updates a product price with specified details.

### Method
POST

### Endpoint
/rest/api/warehouse/price-calculated/

### Parameters
#### Request Body
- **product** (integer) - Required - Unique product ID.
- **price** (integer) - Required - Unique price list ID.
- **customPriceModify** (number or integer or string) - Required - Custom price modification value.
- **customMode** (integer) - Required - The mode for price modification. Enum: 3 (fixed), 5 (overhead), 6 (margin), 7 (static).

### Request Example
```json
{
  "product": 11,
  "price": 12,
  "customPriceModify": 11.12,
  "customMode": 3
}
```

### Responses
#### Success Response (201)
Create/update price correctly.

#### Error Response (401)
Authorization failed.

#### Error Response (422)
Create/Update/Validation price failed.
```

--------------------------------

### Get Carrier Account list.

Source: https://developer.apilo.com/api

Retrieves a list of carrier accounts. Requires Bearer authentication.

```APIDOC
## Get Carrier Account list.

### Description
Retrieves a list of Carrier Account objects.

### Method
GET

### Endpoint
/rest/api/orders/carrier-account/map/

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
Returns list of Carrier Account objects.

#### Response Example
```json
[
  {
    "id": 22,
    "key": "CARRIER_ACCOUNT_143_22",
    "name": "AllegroBroker Minipaczka",
    "description": "Wysyłam z Allegro"
  }
]
```

#### Error Response (401)
Authorization failed.
```

--------------------------------

### Request Sample for Creating a Document

Source: https://developer.apilo.com/api

This is a sample JSON payload for creating a new accounting document. It includes the external ID, document number, status, type, and optional preferences such as a message for printing.

```json
{
  "idExternal": 24,
  "number": "DOC/013/2023",
  "status": 1,
  "type": 1,
  "preferences": {
    "message": "An error occurred while trying to print the receipt"
}

}
```

--------------------------------

### Get Shipment Status Map

Source: https://developer.apilo.com/api

Retrieves a map of shipment statuses used within the Apilo system.

```APIDOC
## GET /rest/api/orders/shipment/status/map/

### Description
Returns a map of all available shipment statuses.

### Method
GET

### Endpoint
/rest/api/orders/shipment/status/map/

### Responses
#### Success Response (200)
- Returns shipment status map.

#### Error Response (401)
- Authorization failed.

### Response Example (200)
```json
[
  {
    "id": "3",
    "key": "CARRIER_253",
    "name": "Inpost (Kurier, Paczkomaty, Allegro)",
    "description": "Kurier"
  }
]
```
```

--------------------------------

### Get Payment Types List

Source: https://developer.apilo.com/api

Retrieves a list of available payment types within the Apilo system.

```APIDOC
## GET /rest/api/orders/payment/map/

### Description
Retrieves a list of available payment types within the Apilo system.

### Method
GET

### Endpoint
/rest/api/orders/payment/map/

### Response
#### Success Response (200)
Returns a list of payment type objects, each containing `id`, `key`, `name`, and `description`.

#### Response Example (200)
```json
[
  {
    "id": 1,
    "key": "PAYMENT_TYPE_BANK_TRANSFER",
    "name": "Przelew bankowy",
    "description": "przelew bankowy"
  },
  {
    "id": 2,
    "key": "PAYMENT_TYPE_COD",
    "name": "Pobranie",
    "description": "za pobraniem"
  },
  {
    "id": 3,
    "key": "PAYMENT_TYPE_SERVICE_PAYU",
    "name": "PayU",
    "description": "serwis PayU"
  }
]
```

#### Error Responses
- **401**: Authorization failed
```

--------------------------------

### Product Attribute Update Response Sample

Source: https://developer.apilo.com/api

This JSON shows a sample response after updating product attributes. It lists updated attributes with their IDs, types, names, and values.

```json
{
  "attributes": [
    {
      "id": 30,
      "type": 1,
      "name": "Manufacturer code",
      "values": [
        {
          "id": 30,
          "value": "123456789"
}
]
},
    {
      "id": 31,
      "type": 16,
      "name": "Color",
      "values": [
        {
          "id": 12
},
        {
          "id": 13
}
]
},
    {
      "id": 32,
      "type": 9,
      "name": "Materials",
      "values": [
        {
          "id": 15,
          "value": "Plastic"
},
        {
          "id": 16,
          "value": "Metal"
}
]
},
    {
      "id": 33,
      "type": 1,
      "name": "Material",
      "values": [
        {
          "id": 17,
          "value": "Plastic"
}
]
},
    {
      "id": 34,
      "type": 2,
      "name": "IsMaterial",
      "values": [
        {
          "id": 18,
          "value": false
}
]
}
]

}
```

--------------------------------

### Location Changes Sample

Source: https://developer.apilo.com/api

Sample response indicating changes in location data.

```json
{
  * "changes": 10
}
```