Status

Is represented by array filled with information related to order status.


Receive a list of all Statuses

Query parameters:
  • fields - list of fields returning in response
  • limit - number of returned statuses (default: 50)
  • page - currently displayed page (default: 1)
  • since_id - restrict statuses to greater identifiers than specified id
  • name - filter with name specified
  • sku - filter with product sku specified
  • created_at_min - shows statuses, which creation date was later than specified (format: 2011-06-19 13:18:50)
  • created_at_max - shows statuses, which creation date was earlier than specified (format: 2011-06-19 13:18:50)
  • updated_at_min - shows statuses, which modification date was later than specified (format: 2011-06-19 13:18:50)
  • updated_at_max - shows statuses, which modification date was earlier than specified (format: 2011-06-19 13:18:50)
GET /services/statuses

Returns all statuses

HTTP/1.1 200 OK
{
	"statuses": [
		{
			"id" : "1",
			"uuid": "64bc99e9-3f99-417c-a704-81a9fbab0e5e",
			"name" : "Nowe",
			"url" : "nowe",
			"color" : "EC451F",
			"send_mail" : "1",
			"mail_template" : "1",
			"change_type" : "0",
			"created_at" : "2011-09-13 18:08:32",
			"updated_at" : "2011-09-13 18:08:32",
		},
		{
			"id" : "2",
			"uuid": "bc279e5b-4b7d-4ba6-82c8-7e259aa74c40",
			"name" : "Spakowane",
			"url" : "spakowane",
			"color" : "BEE5FC",
			"send_mail" : "1",
			"mail_template" : "2",
			"change_type" : "1",
			"created_at" : "2011-11-06 20:25:44",
			"updated_at" : "2011-11-06 20:25:44",
		},
	]
}

Receive a single Status

Query parameters:
  • fields - list of fields returning in response
GET services/statuses/{id}

Receive a single Status

Response
HTTP/1.1 200 OK
{
	"status": {
		"id" : "1",
		"uuid": "64bc99e9-3f99-417c-a704-81a9fbab0e5e",
        "name" : "Nowe",
		"url" : "nowe",
		"color" : "EC451F",
		"send_mail" : "1",
		"mail_template" : "1",
		"change_type" : "0",
		"created_at" : "2011-09-13 18:08:32",
		"updated_at" : "2011-09-13 18:08:32",
	},
}

Create a Status

POST services/statuses

Create status with specified parameters

Request
{
    "status": {
        "name" : "Nowe",
        "url" : "nowe",
        "color" : "1",
        "send_mail" : "1",
        "mail_template" : "1",
        "change_type" : "0",
    },
}
Response
HTTP/1.1 200 OK
{
    "status": {
        "id" : "1",
		"uuid": "64bc99e9-3f99-417c-a704-81a9fbab0e5e",
        "name" : "Nowe",
        "url" : "nowe",
        "color" : "EC451F",
        "send_mail" : "1",
        "mail_template" : "1",
        "change_type" : "0",
        "created_at" : "2011-09-13 18:08:32",
        "updated_at" : "2011-09-13 18:08:32",
    },
}

Update an existing Status

PUT services/statuses/{id}

You can update data of a given status

Request
{
    "status": {
        "name" : "Nowe",
        "url" : "nowe",
        "color" : "1",
        "send_mail" : "1",
        "mail_template" : "1",
        "change_type" : "0",
    },
}
Response
HTTP/1.1 200 OK
{
    "id"	: 5,
}

Delete an existing Status

DELETE services/statuses/{id}

Delete an existing status from a shop

Response
HTTP/1.1 200 OK
{
    "status"	: "ok",
}