Instabox API

https://www.instadocs.se/
Admin
API documentation for integrating with Instabox's logistics services, including authentication,...
Tokens:44,762
Snippets:106
Trust Score:3.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Availability v3 Response Example

Source: https://www.instadocs.se/index

This section provides an example of a successful response from the Availability v3 endpoint, showcasing the structure and data returned for a single service type.

```APIDOC
## GET /websites/instadocs_se/availability/v3

### Description
Retrieves availability information for a given service type.

### Method
GET

### Endpoint
/websites/instadocs_se/availability/v3

### Parameters
#### Query Parameters
- **service_type** (string) - Required - The type of service to check availability for.

### Request Example
```json
{
  "example": "Not applicable for GET request"
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **availability_token** (string) - A token for the availability information.
- **availability** (object) - An object containing availability details for different service types.
  - **[SERVICE_TYPE]** (object) - Details for a specific service type (e.g., EXPRESS).
    - **dispatch_options** (array) - A list of dispatch options.
      - **ready_to_pack** (string) - The timestamp when the item is ready for packing.
      - **delivery_options** (array) - A list of delivery options.
        - **sort_code** (string) - The sort code for the delivery option.
        - **description** (string) - A description of the delivery option.
        - **distance** (object) - Information about the distance to the delivery location.
          - **unit** (string) - The unit of distance.
          - **value** (number) - The numerical value of the distance.
          - **text** (string) - A human-readable representation of the distance.
        - **directions** (object) - Directions to the delivery location.
          - **short** (string) - Short directions.
          - **long** (string) - Long directions.
        - **openhours** (array) - A list of opening hours for the location.
          - **date** (string) - The date for the opening hours.
          - **is_open** (boolean) - Whether the location is open on this date.
          - **open_utc** (string) - The opening time in UTC.
          - **close_utc** (string) - The closing time in UTC.
          - **text_local** (string) - The opening hours in local time format.
        - **openhours_aggregated** (array) - Aggregated opening hours.
          - **title** (string) - The title of the aggregation (e.g., 'Monday-Sunday').
          - **hours** (string) - The aggregated hours.
        - **address** (object) - The address of the delivery location.
          - **street** (string) - The street name.
          - **zip** (string) - The postal code.
          - **city** (string) - The city name.

#### Response Example
```json
{
  "status": "OK",
  "availability_token": "b4a9c200-c02a-4186-b3e8-6271a0be2190",
  "availability": {
    "EXPRESS": {
      "dispatch_options": [
        {
          "ready_to_pack": "2021-06-28T17:22:55.665Z",
          "delivery_options": [
            {
              "sort_code": "IN1",
              "description": "Central Station Stockholm (today ~16:10)",
              "distance": {
                "unit": "meter",
                "value": 177,
                "text": "0.2 km"
              },
              "directions": {
                "short": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit",
                "long": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit. Go to the man behind the counter with a moustache and answer these three questions: 1. What is your name? 2. What is your quest? 3. What is the air-speed velocity of an unladen swallow?"
              },
              "openhours": [
                {
                  "date": "2021-06-29",
                  "is_open": true,
                  "open_utc": "2021-06-28T22:00:00.000Z",
                  "close_utc": "2021-06-29T21:59:00.000Z",
                  "text_local": "00:00-23:59"
                }
              ],
              "openhours_aggregated": [
                {
                  "title": "Monday-Sunday",
                  "hours": "00:00-23:59"
                }
              ],
              "address": {
                "street": "Tulegatan 14",
                "zip": "11353",
                "city": "Stockholm"
              }
            }
          ]
        }
      ]
    }
  }
}
```
```

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

### Tracking URL Example (GET Request)

Source: https://www.instadocs.se/index

An example of a GET request URL for tracking a parcel, using a sample parcel ID.

```http
GET https://track.instabox.io/XX0100000123456
```

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

### Availability v3 C2C Request Example (Minimum Information)

Source: https://www.instadocs.se/index

An example JSON request for the Availability v3 C2C service using minimal required information. It highlights the essential fields for a basic request, though additional recipient details are recommended for better service.

```json
{
  "recipient": {
    "zip": "11120",
    "country_code": "SE"
  },
  "services": [
    {
      "service_type": "C2C"
    }
  ]
}
```

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

### Availability v3 Response Example (JSON)

Source: https://www.instadocs.se/index

Demonstrates a typical response from the Availability v3 API when querying for a single service type. It includes details on status, availability token, and specific dispatch and delivery options with opening hours and addresses.

```json
{
    "status": "OK",
    "availability_token": "b4a9c200-c02a-4186-b3e8-6271a0be2190",
    "availability": {
        "EXPRESS": {
            "dispatch_options": [
                {
                    "ready_to_pack": "2021-06-28T17:22:55.665Z",
                    "delivery_options": [
                        {
                            "sort_code": "IN1",
                            "description": "Central Station Stockholm (today ~16:10)",
                            "distance": {
                                "unit": "meter",
                                "value": 177,
                                "text": "0.2 km"
                            },
                            "directions": {
                                "short": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit",
                                "long": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit. Go to the man behind the counter with a moustache and answer these three questions: 1. What is your name? 2. What is your quest? 3. What is the air-speed velocity of an unladen swallow?"
                            },
                            "openhours": [
                                {
                                    "date": "2021-06-29",
                                    "is_open": true,
                                    "open_utc": "2021-06-28T22:00:00.000Z",
                                    "close_utc": "2021-06-29T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-06-30",
                                    "is_open": true,
                                    "open_utc": "2021-06-29T22:00:00.000Z",
                                    "close_utc": "2021-06-30T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-01",
                                    "is_open": true,
                                    "open_utc": "2021-06-30T22:00:00.000Z",
                                    "close_utc": "2021-07-01T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-02",
                                    "is_open": true,
                                    "open_utc": "2021-07-01T22:00:00.000Z",
                                    "close_utc": "2021-07-02T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-03",
                                    "is_open": true,
                                    "open_utc": "2021-07-02T22:00:00.000Z",
                                    "close_utc": "2021-07-03T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-04",
                                    "is_open": true,
                                    "open_utc": "2021-07-03T22:00:00.000Z",
                                    "close_utc": "2021-07-04T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-05",
                                    "is_open": true,
                                    "open_utc": "2021-07-04T22:00:00.000Z",
                                    "close_utc": "2021-07-05T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                }
                            ],
                            "openhours_aggregated": [
                                {
                                    "title": "Monday-Sunday",
                                    "hours": "00:00-23:59"
                                }
                            ],
                            "address": {
                                "street": "Tulegatan 14",
                                "zip": "11353",
                                "city": "Stockholm"
                            }
                        }
                    ]
                }
            ]
        }
    }
}
```

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

### Availability v3 C2C Request Example (Full Details)

Source: https://www.instadocs.se/index

An example JSON request for the Availability v3 C2C service, demonstrating all available fields for recipient, services, package details, and unit options. This provides a comprehensive payload for the API.

```json
{
  "recipient": {
    "email": "email@domain.com",
    "national_identification_number": "199001012316",
    "mobile_phone_number": "+46701234567",
    "street": "Vasagatan 16",
    "zip": "11120",
    "city": "Stockholm",
    "country_code": "SE"
  },
  "services": [
    {
      "service_type": "C2C",
      "options": {
        "num_delivery_options": 200,
        "response_fields": ["OPENHOURS", "DISTANCE"]
      }
    }
  ],
  "details": {
    "total_value": 123,
    "total_weight": 123,
    "package": {
      "width": 1,
      "height": 1,
      "depth": 1,
      "type": "BOX"
    }
  },
  "options": {
    "units": {
      "dimensions": "mm",
      "weight": "g",
      "currency": "SEK"
    }
  }
}
```

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

### Create Order v2 POST Request Example

Source: https://www.instadocs.se/index

This illustrates the structure of a POST request to the Create Order v2 API endpoint. It requires 'options' and 'order' objects, where 'options' can include 'units' for settings.

```json
{
  "options": {
    "units": {
      "weight": "g",
      "currency": "SEK"
    }
  },
  "order": {
    // Order details will be populated here
  }
}
```

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

### Prebooking v2 Full Request Example

Source: https://www.instadocs.se/index

This JSON object demonstrates a comprehensive request for the Prebooking v2 API, including detailed options, recipient information, service type, delivery options, and extensive parcel and product details.

```json
{
  "options": {
    "units": {
      "weight": "g",
      "currency": "SEK"
    }
  },
  "prebooking": {
    "warehouse_id": "ST123",
    "ready_to_pack": "2023-02-23T07:27:09.176Z",
    "availability_token": "e355e286-f11d-451d-8e65-ca295311a62c",
    "cart_id": "e35x216-a99d",
    "order_number": "1234567",
    "recipient": {
      "name": "Test Testson",
      "street": "Testvägen 1",
      "zip": "12345",
      "city": "Testtown",
      "country_code": "SE",
      "mobile_phone_number": "0701234567",
      "email_address": "email@domain.com"
    },
    "service_type": "EXPRESS",
    "delivery_option": {
      "sort_code": "IN20"
    },
    "parcel_details": {
      "total_weight": 2250,
      "total_value": 9000,
      "parcel_size": {
        "width": 1,
        "height": 1,
        "depth": 1
      },
      "products": [
        {
          "name": "My Little Pony Deathmetal Limited Edition",
          "product_id": "123456",
          "quantity": 1,
          "price": 125,
          "details": {
            "img_url": "https://tinyurl.com/2p9bu4kz",
            "category": "Toy Horses",
            "brand": "My Little Pony",
            "description": "Let the best worlds of Death Metal and Ponies be combined with this awesome toy"
          },
          "packages": [
            {
              "width": 1,
              "height": 1,
              "depth": 1,
              "weight": 1,
              "barcodes": [
                {
                  "code": "123-456-789",
                  "type": "EAN13"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}
```

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

### Create Order v2 - Success Response Example

Source: https://www.instadocs.se/index

This is an example of a successful response from the Instabox v2 API when an order is created. It indicates the order status and lists any warnings encountered during processing. The 'QUEUED' status signifies that the order has been accepted and is being processed.

```http
HTTP/1.1 200 OK
```

```json
{
  "status": "QUEUED",
  "warnings": []
}
```

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

### Prebooking v2 Minimum Request Example

Source: https://www.instadocs.se/index

This JSON object represents a minimal request for the Prebooking v2 API, containing only the essential fields required to initiate a prebooking, such as availability token, service type, and delivery option.

```json
{
  "prebooking": {
    "availability_token": "e355e286-f11d-451d-8e65-ca295311a62c",
    "service_type": "EXPRESS",
    "delivery_option": {
      "sort_code": "IN1"
    }
  }
}
```

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

### Create Order v2 - Full Request Example

Source: https://www.instadocs.se/index

This JSON object demonstrates a complete request for creating an order using the Instabox v2 API. It includes detailed information about units, order specifics, sender, recipient, parcel details, and product information. Ensure all required fields are populated according to the API schema.

```json
{
  "options": {
    "units": {
      "weight": "g",
      "currency": "SEK"
    }
  },
  "order": {
    "warehouse_id": "ST123",
    "ready_to_pack": "2023-02-23T07:27:09.176Z",
    "availability_token": "e355e286-f11d-451d-8e65-ca295311a62c",
    "cart_id": "e35x216-a99d",
    "parcel_id": "XX01000012345678",
    "order_number": "1234567",
    "sender": {
      "name": "Merchant Warehouse 1",
      "street": "Sender Test Street 1",
      "zip": "12345",
      "city": "Testtown",
      "country_code": "SE",
      "warehouse_id": "ST123",
      "return_warehouse_id": "ST124"
    },
    "recipient": {
      "name": "Test Testsson",
      "street": "Consumer Test Street 1",
      "zip": "12345",
      "city": "Testtown",
      "country_code": "SE",
      "mobile_phone_number": "0701234567",
      "email_address": "email@domain.com"
    },
    "service_type": "EXPRESS",
    "delivery_option": {
      "sort_code": "IN20"
    },
    "parcel_details": {
      "total_weight": 2250,
      "total_value": 9000,
      "parcel_size": {
        "width": 1,
        "height": 1,
        "depth": 1
      },
      "products": [
        {
          "name": "My Little Pony Deathmetal Limited Edition",
          "product_id": "123456",
          "quantity": 1,
          "price": 125,
          "details": {
            "img_url": "https://tinyurl.com/2p9bu4kz",
            "category": "Toy Horses",
            "brand": "My Little Pony",
            "description": "Let the best worlds of Death Metal and Ponies be combined with this awesome toy"
          },
          "packages": [
            {
              "width": 1,
              "height": 1,
              "depth": 1,
              "weight": 1,
              "barcodes": [
                {
                  "code": "123-456-789",
                  "type": "EAN13"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}
```

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

### Prebooking v2 Example Response

Source: https://www.instadocs.se/index

This JSON object shows a typical response from the Prebooking v2 API, indicating the status of the prebooking request and confirming details like the availability token, service type, delivery option, and promised estimated time of arrival (ETA).

```json
{
  "status": "CREATED",
  "prebooking": {
    "availability_token": "e355e286-f11d-451d-8e65-ca295311a62c",
    "service_type": "EXPRESS",
    "delivery_option": {
      "sort_code": "IN1"
    },
    "promised_eta": {
      "certainty": "EXACT",
      "eta": "2022-12-01T00:00:00.973Z",
      "is_prioritized_on_create": false
    }
  }
}
```

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

### Generate Shipping Label Curl Request

Source: https://www.instadocs.se/index

Demonstrates how to use curl to make a GET request to the Instabox Label Endpoint v1 for generating shipping labels. This example includes common parameters for label generation.

```bash
curl -X 'GET' \
  'https://waybill-generator-api.instabox.se/v1/waybills?parcel_id=XX0100023107&format=pdf&base64=false&template=a6&dpi=96&debug=false&offset_x=0&offset_y=0&embedded=false&inverted=false' \
  -H 'accept: */*'
```

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

### C2C Availability Example Response (JSON)

Source: https://www.instadocs.se/index

This JSON object represents a sample response for checking the availability of C2C (Customer-to-Customer) services. It includes a status, an availability token, and detailed dispatch and delivery options, such as ready-to-pack times, distance to the collection point, directions, and opening hours.

```json
{
    "status": "OK",
    "availability_token": "b4a9c200-c02a-4186-b3e8-6271a0be2190",
    "availability": {
        "C2C": {
            "dispatch_options": [
                {
                    "ready_to_pack": "2022-06-28T17:22:55.665Z",
                    "delivery_options": [
                        {
                            "sort_code": "IN1",
                            "description": "Central Station Stockholm (today ~16:10)",
                            "distance": {
                                "unit": "meter",
                                "value": 177,
                                "text": "0.2 km"
                            },
                            "directions": {
                                "short": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit",
                                "long": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit. Go to the man behind the counter with a moustache and answer these three questions: 1. What is your name? 2. What is your quest? 3. What is the air-speed velocity of an unladen swallow?"
                            },
                            "openhours": [
                                {
                                    "date": "2021-06-29",
                                    "is_open": true,
                                    "open_utc": "2021-06-28T22:00:00.000Z",
                                    "close_utc": "2021-06-29T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-06-30",
                                    "is_open": true,
                                    "open_utc": "2021-06-29T22:00:00.000Z",
                                    "close_utc": "2021-06-30T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-01",
                                    "is_open": true,
                                    "open_utc": "2021-06-30T22:00:00.000Z",
                                    "close_utc": "2021-07-01T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-02",
                                    "is_open": true,
                                    "open_utc": "2021-07-01T22:00:00.000Z",
                                    "close_utc": "2021-07-02T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-03",
                                    "is_open": true,
                                    "open_utc": "2021-07-02T22:00:00.000Z",
                                    "close_utc": "2021-07-03T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-04",
                                    "is_open": true,
                                    "open_utc": "2021-07-03T22:00:00.000Z",
                                    "close_utc": "2021-07-04T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                },
                                {
                                    "date": "2021-07-05",
                                    "is_open": true,
                                    "open_utc": "2021-07-04T22:00:00.000Z",
                                    "close_utc": "2021-07-05T21:59:00.000Z",
                                    "text_local": "00:00-23:59"
                                }
                            ],
                            "openhours_aggregated": [
                                {
                                    "title": "Monday-Sunday",
                                    "hours": "00:00-23:59"
                                }
                            ],
                            "address": {
                                "street": "Tulegatan 14",
                                "zip": "11353",
                                "city": "Stockholm"
                            }
                        }
                    ]
                }
            ]
        }
    }
}
```

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

### Create Order v2 - Minimum Request Example

Source: https://www.instadocs.se/index

This JSON object represents a minimal request for creating an order via the Instabox v2 API. It focuses on essential fields like order number, recipient, sender, and service type, omitting optional details. This is useful for quick order creation when full details are not immediately available.

```json
{
  "order": {
    "availability_token": "e355e286-f11d-451d-8e65-ca295311a62c",
    "parcel_id": "XX01000012345678",
    "order_number": "1234567",
    "recipient": {
      "name": "Test Testsson",
      "street": "Testvägen 1",
      "zip": "12345",
      "city": "Testtown",
      "country_code": "SE",
      "mobile_phone_number": "0701234567",
      "email_address": "email@domain.com"
    },
    "sender": {
      "name": "Instabox AB",
      "street": "Smältvägen 1",
      "street2": "Port 12",
      "zip": "17236",
      "city": "Bromma",
      "country_code": "SE"
    },
    "service_type": "EXPRESS",
    "delivery_option": {
      "sort_code": "IN20"
    }
  }
}
```

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

### Create C2C Order - JSON Request Body Example

Source: https://www.instadocs.se/index

This snippet demonstrates the structure of a JSON request body for creating a C2C order. It includes nested objects for order details, address, operating hours, and estimated delivery time, along with options for units and descriptions.

```json
{
    "options": {
        "units": {
            "weight": "g",
            "dimensions": "mm",
            "currency": "SEK"
        }
    },
    "order": {
        "order_id": "12345",
        "shipping_method": "Instabox C2C",
        "recipients": [
            {
                "first_name": "John",
                "last_name": "Doe",
                "phone_number": "+46701234567",
                "email": "john.doe@example.com"
            }
        ],
        "parcels": [
            {
                "weight": 1000,
                "width": 100,
                "height": 100,
                "depth": 100,
                "description": "My cool product"
            }
        ],
        "shipping_address": {
            "street": "Tulegatan 20",
            "zip": "11353",
            "city": "Stockholm",
            "country": "Sweden"
        },
        "opening_hours": [
            {
                "title": "Monday",
                "hours": "10:00-18:00"
            },
            {
                "title": "Tuesday",
                "hours": "10:00-18:00"
            },
            {
                "title": "Wednesday",
                "hours": "10:00-18:00"
            },
            {
                "title": "Thursday",
                "hours": "10:00-18:00"
            },
            {
                "title": "Friday",
                "hours": "10:00-18:00"
            },
            {
                "title": "Saturday",
                "hours": "10:00-16:00"
            },
            {
                "title": "Sunday",
                "hours": "Closed"
            }
        ],
        "address": {
            "street": "Tulegatan 20",
            "zip": "11353",
            "city": "Stockholm",
            "country": "Sweden"
        },
        "coordinates": {
            "lat": 59.34544666684217,
            "long": 18.059386443175363
        },
        "pack_before_datetime_utc": "2021-06-28T18:00:00.000Z",
        "cutoff_datetime_utc": "2021-06-28T17:30:00.000Z",
        "eta": {
            "certainty": "EXACT",
            "datetime_utc": "2021-06-29T15:10:00.000Z",
            "datetime_local": "2021-06-29 17:10",
            "text_local": "today"
        }
    }
}
```

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

### Tracking URL (GET Request)

Source: https://www.instadocs.se/index

This is a GET request URL for tracking a parcel. The '{parcelid}' placeholder should be replaced with the actual parcel ID.

```http
GET https://track.instabox.io/{{{parcelid}}}
```

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

### GET /websites/instadocs_se/availability

Source: https://www.instadocs.se/index

Retrieves availability information for Instabox delivery services, including express options and locker details.

```APIDOC
## GET /websites/instadocs_se/availability

### Description
Retrieves availability information for Instabox delivery services, detailing express options, delivery times, and locker locations.

### Method
GET

### Endpoint
/websites/instadocs_se/availability

### Parameters
#### Query Parameters
- **service_type** (string) - Optional - Specifies the type of service to query (e.g., "EXPRESS").

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **status** (string) - The status of the request (e.g., "OK").
- **availability_token** (string) - A token representing the availability information.
- **availability** (object) - An object containing detailed availability information for different service types.
  - **EXPRESS** (object) - Details for the EXPRESS service type.
    - **dispatch_options** (array) - An array of dispatch options.
      - **ready_to_pack** (string) - Datetime when the parcel is ready to be packed (UTC).
      - **delivery_options** (array) - An array of delivery options for the dispatch.
        - **sort_code** (string) - A code identifying the delivery option.
        - **description** (string) - A short description of the delivery option.
        - **directions** (object) - Directions to the delivery location.
          - **short** (string) - Short directions.
          - **long** (string) - Long, detailed directions.
        - **address** (object) - Address of the delivery location.
          - **street** (string) - Street name and number.
          - **zip** (string) - Postal zip code.
          - **city** (string) - City name.
          - **country** (string) - Country name.
        - **coordinates** (object) - Geographic coordinates of the delivery location.
          - **lat** (number) - Latitude.
          - **long** (number) - Longitude.
        - **pack_before_datetime_utc** (string) - Datetime before which the parcel must be packed (UTC).
        - **cutoff_datetime_utc** (string) - Datetime cutoff for packing (UTC).
        - **eta** (object) - Estimated Time of Arrival.
          - **certainty** (string) - Certainty of the ETA (e.g., "EXACT").
          - **datetime_utc** (string) - ETA in UTC.
          - **datetime_local** (string) - ETA in local time.
          - **text_local** (string) - Textual representation of ETA in local time.

#### Response Example
```json
{
    "status": "OK",
    "availability_token": "f4912fa9-f8a9-49ba-b585-fc59e78f84be",
    "availability": {
        "EXPRESS": {
            "dispatch_options": [
                {
                    "ready_to_pack": "2021-06-28T17:49:38.257Z",
                    "delivery_options": [
                        {
                            "sort_code": "IN280",
                            "description": "Norra Real P-hus (today ~16:10)",
                            "directions": {
                                "short": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit",
                                "long": "Take the exit towards Vasagatan. Your Instabox is located in the Convenience Store at the exit. Go to the man behind the counter with a moustache and answer these three questions: 1. What is your name? 2. What is your quest? 3. What is the air-speed velocity of an unladen swallow?"
                            },
                            "address": {
                                "street": "Tulegatan 14",
                                "zip": "11353",
                                "city": "Stockholm",
                                "country": "Sweden"
                            },
                            "coordinates": {
                                "lat": 59.343971,
                                "long": 18.060796
                            },
                            "pack_before_datetime_utc": "2021-06-29T08:00:00.000Z",
                            "cutoff_datetime_utc": "2021-06-29T08:00:00.000Z",
                            "eta": {
                                "certainty": "EXACT",
                                "datetime_utc": "2021-06-29T14:10:00.000Z",
                                "datetime_local": "2021-06-29 16:10",
                                "text_local": "today"
                            }
                        }
                    ]
                }
            ]
        }
    }
}
```
```

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

### Get Product Availability

Source: https://www.instadocs.se/index

Retrieves the availability status and delivery options for products. This endpoint is crucial for checking when and how a product can be delivered, including estimated delivery times.

```APIDOC
## GET /websites/instadocs_se/availability

### Description
Retrieves the availability status and delivery options for products. This endpoint is crucial for checking when and how a product can be delivered, including estimated delivery times.

### Method
GET

### Endpoint
`/websites/instadocs_se/availability`

### Parameters
#### Query Parameters
- **instahome** (boolean) - Optional - Flag to include INSTAHOME delivery options.
- **eta** (boolean) - Optional - Flag to include Estimated Time of Arrival (ETA) details.

### Request Example
```
GET /websites/instadocs_se/availability?instahome=true&eta=true
```

### Response
#### Success Response (200)
- **status** (string) - The status of the availability request (e.g., "OK").
- **availability_token** (string) - A token associated with the availability response.
- **availability** (object) - An object containing availability details for different shipping methods.
  - **INSTAHOME** (object) - Details for INSTAHOME delivery.
    - **dispatch_options** (array) - List of dispatch options.
      - **ready_to_pack** (string) - Timestamp when the item is ready to be packed.
      - **delivery_options** (array) - List of delivery options.
        - **sort_code** (string) - Unique identifier for the delivery option.
        - **description** (string) - User-friendly description of the delivery option.
        - **cutoff_datetime_utc** (string) - UTC timestamp for when orders must be placed for this option.
        - **eta** (object) - Estimated time of arrival details (if requested).
          - **certainty** (string) - Certainty level of the ETA (e.g., "INTERVAL").
          - **datetime_utc** (string) - Predicted delivery time in UTC.
          - **earliest_possible_eta_utc** (string) - Earliest possible delivery time in UTC.
          - **last_possible_eta_utc** (string) - Latest possible delivery time in UTC.
          - **datetime_local** (string) - Predicted delivery time in local time.
          - **text_local** (string) - Localized text describing the delivery time.
        - **pack_before_datetime_utc** (string) - UTC timestamp before which the item must be packed.

#### Response Example
```json
{
    "status": "OK",
    "availability_token": "89d4c85b-e50a-46f9-b1fc-4e4c98e83123",
    "availability": {
        "INSTAHOME": {
            "dispatch_options": [
                {
                    "ready_to_pack": "2021-06-29T08:10:43.118Z",
                    "delivery_options": [
                        {
                            "sort_code": "INh0",
                            "description": "Today, tuesday 29 june, kl 17-22",
                            "cutoff_datetime_utc": "2021-06-30T08:00:00.000Z",
                            "eta": {
                                "certainty": "INTERVAL",
                                "datetime_utc": "2021-06-30T20:00:00.000Z",
                                "earliest_possible_eta_utc": "2021-06-30T15:00:00.000Z",
                                "last_possible_eta_utc": "2021-06-30T20:00:00.000Z",
                                "datetime_local": "2021-06-30 22:00",
                                "text_local": "today"
                            },
                            "pack_before_datetime_utc": "2021-06-28T08:00:00.000Z"
                        }
                    ],
                    "taglines": {}
                }
            ],
            "preselection": "ALLOWED",
            "descriptions": {},
            "fossil_free": false,
            "show_as_option": true
        }
    }
}
```
```

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

### Checkpoint Export Data Structures

Source: https://www.instadocs.se/index

Defines the possible checkpoints for parcel journey status and provides an example JSON structure for checkpoint data. This helps in understanding the format and content of exported status events.

```json
{
  "InitialCheckpoint": "Order information received",
  "InitialReturnCheckpoint": "Return activated",
  "SortingMachineCheckpoint": "Sorted",
  "SortingStationCheckpoint": "Sorted",
  "CourierDropoffCheckpoint": "Dropped off at locker by courier",
  "CourierPickupCheckpoint": "Picked up at locker by courier",
  "CustomerPickupCheckpoint": "Picked up at locker by customer",
  "CustomerDropoffCheckpoint": "Dropped off at locker by customer",
  "ReturnedToSenderCheckpoint": "Returned to sender",
  "ReturnToSenderCheckpoint": "Return to sender",
  "CustomerHomeDeliveryBooked": "Home Delivery is booked",
  "CustomerHomeDeliverySuccess": "Home delivery was successfull, parcel is delivered to customer",
  "CustomerHomeDeliveryFail": "Home delivery failed, parcel was not delivered to customer",
  "ParcelLostCheckpoint": "Parcel was lost. Please contact us to find out why."
}
```

```json
{
  "checkpoint_id": "Id String",
  "parcel_id": "Parcel ID, ie barcode",
  "order_number": "Merchants’s order reference",
  "type": "Initial|Sorting|CourierDropoff|CustomerPickup|CustomerDropoff|CourierPickup",
  "type_description": "type_description",
  "location_name": "location_name",
  "timestamp": "ISO-8601 Date String w UTC time zone"
}
```

```json
{
  "checkpoint_id": "614b2d3f7a90d7151146b399",
  "parcel_id": "XX0100001234567",
  "order_number": "OR123456",
  "type": "SortingStationCheckpoint",
  "type_description": "Sorted",
  "location_name": "Stockholm DC",
  "timestamp": "2021-10-01T01:23:45.678Z"
}
```

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

### Availability v3 Request with Full Details (JSON)

Source: https://www.instadocs.se/index

This JSON object demonstrates a comprehensive Availability v3 request for Instadocs SE, including recipient details, service configurations, package dimensions, product information, and unit preferences. It serves as a template for detailed service availability queries.

```json
{
  "recipient": {
    "email": "email@domain.com",
    "street": "Vasagatan 16",
    "zip": "11120",
    "city": "Stockholm",
    "country_code": "SE"
  },
  "services": [
    {
      "service_type": "EXPRESS",
      "dispatch_options": [
        {
          "ready_to_pack": "2022-12-01T01:23:45.678Z",
          "warehouse_id": "SE-STOCKHOLM"
        }
      ],
      "options": {
        "num_delivery_options": 25,
        "num_dispatch_options": 1,
        "response_fields": ["OPENHOURS", "DISTANCE"],
        "sort_dispatch_options_by": [
          { "field": "eta", "direction": "DESC" },
          { "field": "ready_to_pack", "direction": "ASC" }
        ]
      }
    }
  ],
  "details": {
    "total_value": 123,
    "total_weight": 123,
    "package": {
      "width": 1,
      "height": 1,
      "depth": 1,
      "weight": 1,
      "type": "BOX"
    },
    "products": [
      {
        "quantity": 1,
        "product_id": "12345678",
        "packages": [
          {
            "width": 1,
            "height": 1,
            "depth": 1,
            "weight": 1
          }
        ]
      }
    ]
  },
  "options": {
    "units": {
      "dimensions": "mm",
      "weight": "g",
      "currency": "SEK"
    }
  }
}
```

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

### Order Details

Source: https://www.instadocs.se/index

Contains general details about the order, including weight, value, and package dimensions.

```APIDOC
## order.details

### Description
General details about the order.

### Properties
- **total_weight** (number) - Optional - Total weight of order
- **total_value** (number) - Optional - Total value of products within order
- **package** (object) - Required - The estimated size of your package. Providing this will allow us to return show_as_option: false for packages that wouldn't fit in our lockers.

### order.details.package

#### Properties
- **width** (number) - Required - Width of the package, in the unit specified by options.units.dimensions
- **height** (number) - Required unless diameter is specified - Height of the package, in the unit specified by options.units.dimensions
- **depth** (number) - Required unless diameter is specified - Depth of the package, in the unit specified by options.units.dimensions
- **diameter** (number) - Required unless height and depth is specified - Diameter of the package, in the unit specified by options.units.dimensions
- **type** (string) - Optional - The type of the package
```

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

### Order Details

Source: https://www.instadocs.se/index

Contains general details about the order, including weight, value, and package specifications.

```APIDOC
## order.details

### Description
Details about the order including weight, value and package dimensions.

### Parameters
#### Request Body
- **total_weight** (number) - Optional - Total weight of order
- **total_value** (number) - Optional - Total value of products within order
- **package** (object) - Required - The estimated size of your package. Providing this will allow us to return show_as_option: false for packages that wouldn't fit in our lockers

#### order.details.package
- **width** (number) - Required - Width of the package, in the unit specified by options.units.dimensions
- **height** (number) - Required unless diameter is specified - Height of the package, in the unit specified by options.units.dimensions
- **depth** (number) - Required unless diameter is specified - Depth of the package, in the unit specified by options.units.dimensions
- **diameter** (number) - Required unless height and depth is specified - Diameter of the package, in the unit specified by options.units.dimensions
- **type** (string) - Optional - The type of the package
```

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

### Generate Shipping Label URL Request

Source: https://www.instadocs.se/index

Constructs a GET request URL to the Instabox Label Endpoint v1 for generating shipping labels. It includes parameters for parcel ID, format, encoding, template, DPI, debug mode, and offsets.

```url
https://waybill-generator-api.instabox.se/v1/waybills?parcel_id=XX0100023107&format=pdf&base64=false&template=a6&dpi=96&debug=false&offset_x=0&offset_y=0&embedded=false&inverted=false
```

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

### Order Availability Token Documentation

Source: https://www.instadocs.se/index

Details the availability tokens required for order creation.

```APIDOC
## Order Availability Tokens

### Description
Tokens used to validate availability for order placement.

### Properties

- **availability_token** (string) - Required - Token received from the call to Availability API for the recipient (aka buyer). Do not modify this token.
- **sender_availability_token** (string) - Required - Token received from the call to Availability API for the sender (aka seller). Do not modify this token.
```
Tokens:
Raw