Explore

Retrieve all suppliers

GET/store/suppliers

Gets information about all suppliers 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": 1,
  "count": 50,
  "offset": 0,
  "results": [
    {
      "id": "5aba8b1b9b04b5226c7f3417",
      "name": "Divendo",
      "accountnumber": null,
      "logo": "",
      "contact": {
        "name": {
          "title": "Mr",
          "firstname": "Test",
          "surname": "Person"
        },
        "email": null,
        "address": {
          "addressline1": "20-22 Wenlock Road",
          "addressline2": "",
          "addressline3": "",
          "towncity": "London",
          "stateprovince": "London",
          "postalcode": "N1 7GU",
          "country": "GB"
        },
        "numbers": [
          "+442030869860"
        ]
      }
    }
  ]
}

Lookup a specific supplier

GET/store/suppliers/{id}

Gets information about a specific supplier within your store configuration.

Parameters

The unique id for the supplier

Example response

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

{
  "id": "571eb85ef161f1834cfa4c1f",
  "name": "Divendo",
  "accountnumber": "",
  "logo": "",
  "contact": {
    "name": {
      "title": null,
      "firstname": "Test",
      "initial": null,
      "surname": "Person"
    },
    "email": "[email protected]",
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "London",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": {
        "name": "United Kingdom",
        "isocode": "GB",
        "zone": "united kingdom"
      }
    },
    "numbers": [
      {
        "type": "daytime",
        "number": "+442030869860"
      }
    ]
  }
}

Create a new supplier

POST/store/suppliers

Creates a new supplier within your store configuration.

Request body

Supplier

Example request

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

{
  "name": "Divendo",
  "accountnumber": null,
  "logo": "",
  "contact": {
    "name": {
      "title": "Mr",
      "firstname": "Test",
      "surname": "Person"
    },
    "email": null,
    "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": "5aba8b1b9b04b5226c7f3417",
  "name": "Divendo",
  "accountnumber": null,
  "logo": "",
  "contact": {
    "name": {
      "title": "Mr",
      "firstname": "Test",
      "surname": "Person"
    },
    "email": null,
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "London",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": "GB"
    },
    "numbers": [
      "+442030869860"
    ]
  }
}

Update a supplier

PUT/store/suppliers/{id}

Updates the settings for a specific supplier.

Parameters	id	The unique id for the supplier
Request body	Supplier

Example request

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

{
  "name": "Divendo",
  "accountnumber": "DIV123",
  "logo": "",
  "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": "5aba8b1b9b04b5226c7f3417",
  "name": "Divendo",
  "accountnumber": "DIV123",
  "logo": "",
  "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"
    ]
  }
}

Delete a supplier

DELETE/store/suppliers/{id}

Deletes a supplier from your store configuration.

Parameters

The unique id for the supplier

Example response

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