Resello REST API Documentation

GET order

Returns a list of orders, matching an optional customer id.

Resource URL

https://backoffice.hostcontrol.com/api/v1/order

Parameters

Parameter Required? Description Example value
customer optional Id of a customer. Returns orders only belonging to this customer. 13

Example requests


GET    https://backoffice.hostcontrol.com/api/v1/order

Result

{
   "result": [
      {
         "customer": {
            "is_enabled": true,
            "updated": "2013-10-14T12:14:01.411341+00:00",
            "is_dns_management_enabled": true,
            "created": "2013-10-14T12:14:01.411298+00:00",
            "primary_contact": {
               "city": "Groningen",
               "fax": "",
               "voice": "+31.612345678",
               "updated": "2013-10-22T11:46:14.084454+00:00",
               "name": "John Doe",
               "created": "2013-10-22T11:46:14.084419+00:00",
               "gender": null,
               "organisation": "",
               "extra": {},
               "zipcode": "1234AA",
               "email": "john@doe.com",
               "state": "Groningen",
               "address": "Street 123",
               "domains": [],
               "vat_number": null,
               "country": {
                  "code": "NL",
                  "name": "Netherlands"
               },
               "type": "primary",
               "id": 14
            },
            "is_receiving_support_notifications": true,
            "is_ns_management_enabled": true,
            "is_verified": true,
            "id": 13
         },
         "created": "2013-10-24T18:31:19.765344+00:00",
         "state": "new",
         "parts": [
            {
               "domain": {
                  "name": "my-new-test-domain.nl"
               },
               "description": "my-new-test-domain.nl, 12 months\n",
               "last_error": null,
               "price": null,
               "interval": 12,
               "state": "pending",
               "is_privacy_protect_enabled": false,
               "type": "domain-register-order",
               "id": 16,
               "tld": {
                  "name": "nl"
               }
            }
         ],
         "invoice": null,
         "type": "new",
         "id": 33
      },
      {
         "customer": {
            "is_enabled": true,
            "updated": "2013-10-14T12:14:01.411341+00:00",
            "is_dns_management_enabled": true,
            "created": "2013-10-14T12:14:01.411298+00:00",
            "primary_contact": {
               "city": "Kampen",
               "fax": "",
               "voice": "+31.31389874563",
               "updated": "2013-10-14T12:14:01.417295+00:00",
               "name": "John Smith",
               "created": "2013-10-14T12:14:01.417269+00:00",
               "gender": null,
               "organisation": "",
               "extra": {},
               "zipcode": "8014AA",
               "email": "john@smith.familysmith.nl",
               "state": "Overijssel",
               "address": "MyStreet 15",
               "domains": [],
               "vat_number": null,
               "country": {
                  "code": "NL",
                  "name": "Netherlands"
               },
               "type": "primary",
               "id": 14
            },
            "is_receiving_support_notifications": true,
            "is_ns_management_enabled": true,
            "is_verified": true,
            "id": 13
         },
         "created": "2013-10-24T17:36:42.074539+00:00",
         "state": "new",
         "parts": [
            {
               "domain": {
                  "name": "familysmith.nl"
               },
               "description": "familysmith.nl, 12 months\n",
               "last_error": null,
               "price": null,
               "interval": 12,
               "state": "pending",
               "is_privacy_protect_enabled": false,
               "type": "domain-register-order",
               "id": 14,
               "tld": {
                  "name": "nl"
               }
            }
         ],
         "invoice": null,
         "type": "new",
         "id": 30
      },
      {
         "customer": {
            "is_enabled": true,
            "updated": "2013-10-15T08:04:39.573470+00:00",
            "is_dns_management_enabled": true,
            "created": "2013-10-15T08:04:39.573433+00:00",
            "primary_contact": {
               "city": "Zwolle",
               "fax": "",
               "voice": "+31.31612151215",
               "updated": "2013-10-15T08:04:39.631424+00:00",
               "name": "Henk de Vries",
               "created": "2013-10-15T08:04:39.631380+00:00",
               "gender": null,
               "organisation": "",
               "extra": {},
               "zipcode": "8080AW",
               "email": "henk.de.vries@firstfind.nl",
               "state": "Overijssel",
               "address": "Ceintuurbaan 512",
               "domains": [],
               "vat_number": null,
               "country": {
                  "code": "NL",
                  "name": "Netherlands"
               },
               "type": "primary",
               "id": 19
            },
            "is_receiving_support_notifications": true,
            "is_ns_management_enabled": true,
            "is_verified": true,
            "id": 16
         },
         "created": "2013-10-15T08:04:39.896015+00:00",
         "state": "new",
         "parts": [
            {
               "domain": {
                  "name": "henkdevries-random1234.net"
               },
               "description": "henkdevries-random1234.net, 12 months\n",
               "last_error": null,
               "price": null,
               "interval": 12,
               "state": "pending",
               "is_privacy_protect_enabled": false,
               "type": "domain-register-order",
               "id": 3,
               "tld": {
                  "name": "net"
               }
            }
         ],
         "invoice": null,
         "type": "new",
         "id": 3
      }
   ],
   "success": true
}

GET    https://backoffice.hostcontrol.com/api/v1/order?customer=13

Result

{
   "result": [
      {
         "customer": {
            "is_enabled": true,
            "updated": "2013-10-14T12:14:01.411341+00:00",
            "is_dns_management_enabled": true,
            "created": "2013-10-14T12:14:01.411298+00:00",
            "primary_contact": {
               "city": "Zwolle",
               "fax": "",
               "voice": "+31.31381234567",
               "updated": "2013-10-14T12:14:01.417295+00:00",
               "name": "John Doe",
               "created": "2013-10-14T12:14:01.417269+00:00",
               "gender": null,
               "organisation": "",
               "extra": {},
               "zipcode": "8024AA",
               "email": "johndoe@hotmail.com",
               "state": "Overijssel",
               "address": "Streetname 123",
               "domains": [],
               "vat_number": null,
               "country": {
                  "code": "NL",
                  "name": "Netherlands"
               },
               "type": "primary",
               "id": 14
            },
            "is_receiving_support_notifications": true,
            "is_ns_management_enabled": true,
            "is_verified": true,
            "id": 13
         },
         "created": "2013-10-24T18:31:19.765344+00:00",
         "state": "new",
         "parts": [
            {
               "domain": {
                  "name": "test-domain.nl"
               },
               "description": "test-domain.nl, 12 months\n",
               "last_error": null,
               "price": null,
               "interval": 12,
               "state": "pending",
               "is_privacy_protect_enabled": false,
               "type": "domain-register-order",
               "id": 16,
               "tld": {
                  "name": "nl"
               }
            }
         ],
         "invoice": null,
         "type": "new",
         "id": 33
      },
      {
         "customer": {
            "is_enabled": true,
            "updated": "2013-10-14T12:14:01.411341+00:00",
            "is_dns_management_enabled": true,
            "created": "2013-10-14T12:14:01.411298+00:00",
            "primary_contact": {
               "city": "Zwolle",
               "fax": "",
               "voice": "+31.31381234567",
               "updated": "2013-10-14T12:14:01.417295+00:00",
               "name": "John Doe",
               "created": "2013-10-14T12:14:01.417269+00:00",
               "gender": null,
               "organisation": "",
               "extra": {},
               "zipcode": "8024AA",
               "email": "johndoe@hotmail.com",
               "state": "Overijssel",
               "address": "Streetname 123",
               "domains": [],
               "vat_number": null,
               "country": {
                  "code": "NL",
                  "name": "Netherlands"
               },
               "type": "primary",
               "id": 14
            }, 
            "is_receiving_support_notifications": true,
            "is_ns_management_enabled": true,
            "is_verified": true,
            "id": 13
         },
         "created": "2013-10-24T18:14:01.343394+00:00",
         "state": "new",
         "parts": [
            {
               "domain": {
                  "name": "my-new-test-domain.nl"
               },
               "description": "my-new-test-domain.nl, 12 months\n",
               "last_error": null,
               "price": null,
               "interval": 12,
               "state": "pending",
               "is_privacy_protect_enabled": false,
               "type": "domain-register-order",
               "id": 15,
               "tld": {
                  "name": "nl"
               }
            }
         ],
         "invoice": null,
         "type": "new",
         "id": 32
      }
   ],
   "success": true
}