Explore

Retrieve all brands

GET/store/brands

Gets information about all brands within your store configuration.

Querystring	count	The number of records to return
Querystring	offset	The number of records from a collection to skip

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "total": 1218,
  "count": 1,
  "offset": 0,
  "results": [
    {
      "id": "55f83c0187bb3831384b5b66",
      "name": "007 Fragrances",
      "accountnumber": null,
      "logo": "/userdata/root/images/brands/007-fragrances.jpg",
      "url": "/brands/007-fragrances",
      "contact": {
        "name": {
          "title": "",
          "firstname": "",
          "surname": ""
        },
        "email": null,
        "address": {
          "addressline1": "",
          "addressline2": "",
          "addressline3": "",
          "towncity": "",
          "stateprovince": "",
          "postalcode": "",
          "country": null
        },
        "numbers": [
        ]
      }
    }
  ]
}

Lookup a specific brand

GET/store/brands/{id}

Gets information about a specific brand within your store configuration.

Parameters

The unique id for the brand

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "55f83c0187bb3831384b5b66",
  "name": "007 Fragrances",
  "accountnumber": null,
  "logo": "/userdata/root/images/brands/007-fragrances.jpg",
  "url": "/brands/007-fragrances",
  "contact": {
    "name": {
      "title": "",
      "firstname": "",
      "surname": ""
    },
    "email": null,
    "address": {
      "addressline1": "",
      "addressline2": "",
      "addressline3": "",
      "towncity": "",
      "stateprovince": "",
      "postalcode": "",
      "country": null
    },
    "numbers": [
    ]
  }
}

Create a new brand

POST/store/brands

Creates a new brand within your store configuration.

Request body

Brand

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Divendo Test",
  "accountnumber": "",
  "logo": "",
  "url": "",
  "contact": {
    "name": {
      "title": "Mr",
      "firstname": "Test",
      "surname": "Person"
    },
    "email": "[email protected]",
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "London",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": "GB"
    },
    "numbers": [
      "+442030869860"
    ]
  }
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "571ecabbf161b19808b243cd",
  "name": "Divendo Test",
  "accountnumber": "",
  "logo": "",
  "url": "",
  "contact": {
    "name": {
      "title": "Mr",
      "firstname": "Test",
      "surname": "Person"
    },
    "email": "[email protected]",
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "London",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": "GB"
    },
    "numbers": [
      "+442030869860"
    ]
  }
}

Update a brand

PUT/store/brands/{id}

Updates the settings for a specific brand.

Parameters	id	The unique id for the brand
Request body	Brand

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Divendo Test",
  "accountnumber": "DIVENDOTEST",
  "logo": "",
  "url": "",
  "contact": {
    "name": {
      "title": "Mrs",
      "firstname": "Test",
      "surname": "Person"
    },
    "email": "[email protected]",
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "London",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": "GB"
    },
    "numbers": [
      "+442030869860"
    ]
  }
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "571ecabbf161b19808b243cd",
  "name": "Divendo Test",
  "accountnumber": "DIVENDOTEST",
  "logo": "",
  "url": "",
  "contact": {
    "name": {
      "title": "Mrs",
      "firstname": "Test",
      "surname": "Person"
    },
    "email": "[email protected]",
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "London",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": "GB"
    },
    "numbers": [
      "+442030869860"
    ]
  }
}

Delete a brand

DELETE/store/brands/{id}

Deletes a brand from your store configuration.

Parameters

The unique id for the brand

Example response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8