API Documentation

Get categories

get

Returns categories.Example shown is using a Shop API key without query parameters.If a Baxx API key is used the response is the same but without the translations array.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

[]

Get categories from one country in one language

get

Returns categories of given country in given language.Example shown is using a Shop API key with query parameters.Use lower-case letters for country and language codes.

Query parameters

countrystring · lower-caseRequired

Two-letter country code.Only relevant if Shop API key is used.

languagestring · lower-caseRequired

Two-letter language code.Only relevant if Shop API key is used.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

[]

Get and search for models

get

Returns 100 models at a time for the relevant shop. To get all models make multiple calls.

Query parameters

offsetintegerOptional

Not needed in first call, if not set the API will return the first 100 models. Increase incrementally in steps of 100 to get all models.

searchstringOptional

If search is included, only matches for the search term will be returned.Searches in all model fields.Case insensitive.

Example: ipad

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

[]

Get products

get

Returns 100 products at a time for the relevant shop. To get all products make multiple calls.

Query parameters

offsetintegerOptional

Not needed in first call, if not set the API will return the first 100 products.Increase 'offset' incrementally in steps of 100 to get all products.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

[]

Get one product

get

Returns one product with full questionaire in the relevant language for the relevant country, with prices.Use lower-case letters for country and language codes.

Query parameters

countrystring · lower-caseRequired

Two letter country code.

languagestring · lower-caseRequired

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

{
  "id": "bc0d7ddd9ad2fa4f032f46c2df8881b9",
  "title": "Apple iPad 10 64GB WiFi 2022",
  "options": {
    "memory": "64GB",
    "network": "WiFi",
    "year": 2022
  },
  "questionaire": {
    "type": "question",
    "text": "Does the device turn on and start up successfully? Is the device also free of locks?",
    "info": "Answer Yes if:<br/> Your device turns on and starts up completely<br/> There is no iCloud lock<br/> There is no passcode lock<br/> <br/> Answer No if:<br/> The device does not turn on or does not start up at all<br/> There are locks on the device",
    "answers": []
  }
}

Get product tags

get

Returns product tags.Example shown is using a Shop API key without query parameters.If a Baxx API key is used the response is the same but without the translations array.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

[]

Get product tags from one country in one language

get

Returns product tags of given country in given language.Example shown is using a Shop API key with query parameters.Use lower-case letters for country and language codes.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

[]

Get shipping options

get

Returns shipping options for a shop.Can only be used with a Shop API key.Country and language query parameters are needed to create carrier links to drop-off locations.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

[]

Get cart contents

get

Can only be used with Shop API key.Returns all products in the shopping cart, with model info, completed questionaires in the relevant language and the price for the relevant country.Use lower-case letters for country and language codes.Use the query string array notation '[]' for the items

Query parameters

countrystring · lower-caseRequired

Two letter country code.

languagestring · lower-caseRequired

item[]stringRequired

Product id followed by quantity and then the indexes of the answers from the questionaire, comma separated.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

{
  "total": 490,
  "cart": [
    {
      "id": "3dd141beabf887aabdc7ef2f2c0a83cb",
      "category": "Smartphone",
      "brand": "Xiaomi",
      "model": "Redmi 9A",
      "qty": 1,
      "options": {
        "memory": "32GB"
      },
      "imageUrl": "https://circlereu.change.watch/images/products/101024.jpg",
      "qa": [
        {
          "q": "Gaat het device aan, start het succesvol op en is het daarnaast vrij van locks?",
          "a": "Nee"
        }
      ],
      "price": 50
    },
    {
      "id": "bd9c5eb258b6268a52c0f44ff58d7cea",
      "category": "Tablet",
      "brand": "Apple",
      "model": "iPad 1",
      "qty": 2,
      "options": {
        "memory": "16GB",
        "network": "WiFi + 3G",
        "year": 2010
      },
      "imageUrl": "https://circlereu.change.watch/images/products/100229.jpg",
      "qa": [
        {
          "q": "Gaat het device aan, start het succesvol op en is het daarnaast vrij van locks?",
          "a": "Ja"
        },
        {
          "q": "Is het device vrij van barsten?",
          "a": "Ja"
        },
        {
          "q": "Werken alle functies van het device?",
          "a": "Nee"
        }
      ],
      "price": 220
    }
  ],
  "message": "ok"
}

Get orders

get

Can only be used with Baxx API key.Returns all orders with an array of items with their current status.

Responses

get

GET /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Accept: */*

200

Ok: Successfully processed the request.

[
  {
    "id": 61,
    "orderNr": "HLQ3XR9PCE",
    "timestamp": 1704985079,
    "affiliate": null,
    "shopId": 1,
    "shopName": "Baxx",
    "firstName": "Sara",
    "lastName": "Murray",
    "country": "nl",
    "language": "nl",
    "email": "sara.murray@example.com",
    "companyName": "Mac Donalds",
    "tax": "vat",
    "shipping": {
      "shipmentType": "label",
      "trackingCode": "MDP5WNL4WGK"
    },
    "date": "2024-01-11T15:57:59+01:00",
    "items": [
      {
        "id": 90,
        "status": "expected",
        "date": "2024-01-11T15:57:59+01:00",
        "deviceId": "6f647dc70b1f3b5839f53f7574b10d57",
        "deviceName": "Apple iPhone 12 128GB",
        "price_EUR": 930.23
      }
    ]
  },
  {
    "id": 60,
    "orderNr": "HLQ3V7I63R",
    "timestamp": 1704984930,
    "affiliate": null,
    "shopId": 1,
    "shopName": "Baxx",
    "firstName": "Sara",
    "lastName": "Murray",
    "country": "nl",
    "language": "nl",
    "email": "sara.murray@example.com",
    "companyName": "Mac Donalds",
    "tax": "vat",
    "shipping": {
      "shipmentType": "label",
      "trackingCode": "MDP6WGK5WNL"
    },
    "date": "2024-01-11T15:55:30+01:00",
    "items": [
      {
        "id": 89,
        "status": "expected",
        "date": "2024-01-11T15:55:30+01:00",
        "deviceId": "6f647dc70b1f3b5839f53f7574b10d57",
        "deviceName": "Apple iPhone 12 128GB",
        "price_EUR": 930.23
      }
    ]
  },
  {
    "id": 59,
    "orderNr": "HLQ3NODQXW",
    "timestamp": 1704984497,
    "affiliate": null,
    "shopId": 1,
    "shopName": "Baxx",
    "firstName": "Sara",
    "lastName": "Murray",
    "country": "nl",
    "language": "en",
    "email": "sara.murray@example.com",
    "companyName": "",
    "tax": "margin",
    "shipping": {
      "shipmentType": "store"
    },
    "date": "2024-01-11T15:48:17+01:00",
    "items": [
      {
        "id": 88,
        "status": "expected",
        "date": "2024-01-11T15:48:17+01:00",
        "deviceId": "3dd141beabf887aabdc7ef2f2c0a83cb",
        "deviceName": "Xiaomi Redmi 9A 32GB",
        "price_EUR": 45
      },
      {
        "id": 87,
        "status": "expected",
        "date": "2024-01-11T15:48:17+01:00",
        "deviceId": "bc0d7ddd9ad2fa4f032f46c2df8881b9",
        "deviceName": "Apple iPad 10 64GB WiFi 2022",
        "price_EUR": 589
      }
    ]
  }
]

Place an order

post

Can only be used with Shop API key.The IP address should be that of the customer.

Body

Responses

post

POST /baxx/v1 HTTP/1.1
Host: [accountname].baxx.app
Content-Type: application/json
Accept: */*
Content-Length: 450

{
  "details": {
    "firstName": "Sara",
    "lastName": "Murray",
    "email": "sara.murray@example.com",
    "iban": "NL07INGB0002459388",
    "postcode": "1000AA",
    "houseNumber": "1",
    "streetName": "Sesamestreet",
    "city": "Wonderland",
    "country": "nl",
    "phoneNumber": "0612345678",
    "companyName": "Mac Donalds",
    "taxNumber": "NL809535123",
    "tax": "tax",
    "ip": "100.100.100.100",
    "language": "nl",
    "shippingId": "sendcloud_492"
  },
  "basket": [
    {
      "id": "032bb327dd3812f061fc82e78a04e35b",
      "qa": [
        0,
        0,
        1
      ],
      "qty": 1
    }
  ]
}

{
  "result": true,
  "orderNr": "HJCC6XA371",
  "shipmentType": "label",
  "labelLink": "https://baxx.baxx.app/baxx/?attachmentId=lb_HLQ3XR9PCE_MDP5WNL4WGK.pdf&hash=0fc06d12118e4138db70867f58ff2f363c9eb01b546863c0ecee7dd324312436",
  "trackingCode": "MDP5WNL4WGK",
  "trackingLink": "https://tracking.eu-central-1-0.sendcloud.sc/forward?carrier=dhl&code=MDP5WNL4WGK&destination=NL&lang=nl-nl&source=NL&type=parcel&verification=1056+PZ&servicepoint_verification=&created_at=2023-11-29&from_postal_code=1000+AA"
}