{"openapi":"3.0.3","info":{"title":"Ease Your Tasks API","version":"1.0.0","description":"Create and read delivery orders for an Ease Your Tasks account. Authenticate with an API key from Account → API. The same key is used by WordPress and by any other integration."},"servers":[{"url":"https://api.easeyourtasks.com/v1"}],"tags":[{"name":"Orders"}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"Authorization: Bearer ey_live_..."}},"schemas":{"Order":{"type":"object","required":["id","customer","address","deliveryDate","status","priority"],"properties":{"id":{"type":"string","description":"Ease Your Tasks order id.","example":"6740c9e1a1b2c3d4e5f60718"},"externalId":{"type":"string","nullable":true,"description":"Your stable id. Unique per account. A repeat create with the same externalId returns the original order.","example":"woocommerce:shop.example:1001"},"orderNumber":{"type":"string","nullable":true,"example":"1001"},"source":{"type":"string","nullable":true,"example":"woocommerce"},"customer":{"type":"object","required":["name","phone"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string","nullable":true}}},"address":{"type":"string"},"location":{"type":"object","nullable":true,"properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"deliveryDate":{"type":"string","format":"date","example":"2026-11-08"},"status":{"type":"string","enum":["NotAssigned","Assigned","PathAssigned","SentToDriver","Accepted","OnTheWay","Delivered","Picked","Returned","Failed"]},"priority":{"type":"string"},"items":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"paymentStatus":{"type":"string","nullable":true},"timeWindow":{"type":"object","properties":{"start":{"type":"integer","nullable":true,"minimum":1,"maximum":24},"end":{"type":"integer","nullable":true,"minimum":1,"maximum":24}}},"driverName":{"type":"string","nullable":true}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}},"security":[{"ApiKey":[]}],"paths":{"/orders":{"post":{"tags":["Orders"],"operationId":"createOrder","summary":"Create a delivery order","description":"Geocodes the address, uses one order credit, and returns the order. Send externalId or an Idempotency-Key so a retry does not create a second delivery. A replay returns 200 and Idempotent-Replayed: true and does not use another credit.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255},"description":"Unique per request attempt. The same key and body replay the original response for 24 hours."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer","address","deliveryDate"],"properties":{"externalId":{"type":"string","nullable":true,"description":"Your stable id. Unique per account. A repeat create with the same externalId returns the original order.","example":"woocommerce:shop.example:1001"},"orderNumber":{"type":"string","maxLength":64},"source":{"type":"string","description":"Short lowercase label, for example woocommerce. Defaults to api."},"customer":{"type":"object","required":["name","phone"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string","nullable":true}}},"address":{"type":"string","maxLength":500},"deliveryDate":{"type":"string","format":"date"},"items":{"type":"string"},"instructions":{"type":"string"},"paymentStatus":{"type":"string"},"priority":{"type":"string","description":"A priority configured on the account. Unknown values use the account default."},"timeWindow":{"type":"object","properties":{"start":{"type":"integer","minimum":1,"maximum":24},"end":{"type":"integer","minimum":1,"maximum":24}}}}}}}},"responses":{"200":{"description":"Existing order returned for a duplicate externalId or Idempotency-Key.","headers":{"Idempotent-Replayed":{"schema":{"type":"string","example":"true"}}},"content":{"application/json":{"schema":{"type":"object","required":["id","customer","address","deliveryDate","status","priority"],"properties":{"id":{"type":"string","description":"Ease Your Tasks order id.","example":"6740c9e1a1b2c3d4e5f60718"},"externalId":{"type":"string","nullable":true,"description":"Your stable id. Unique per account. A repeat create with the same externalId returns the original order.","example":"woocommerce:shop.example:1001"},"orderNumber":{"type":"string","nullable":true,"example":"1001"},"source":{"type":"string","nullable":true,"example":"woocommerce"},"customer":{"type":"object","required":["name","phone"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string","nullable":true}}},"address":{"type":"string"},"location":{"type":"object","nullable":true,"properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"deliveryDate":{"type":"string","format":"date","example":"2026-11-08"},"status":{"type":"string","enum":["NotAssigned","Assigned","PathAssigned","SentToDriver","Accepted","OnTheWay","Delivered","Picked","Returned","Failed"]},"priority":{"type":"string"},"items":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"paymentStatus":{"type":"string","nullable":true},"timeWindow":{"type":"object","properties":{"start":{"type":"integer","nullable":true,"minimum":1,"maximum":24},"end":{"type":"integer","nullable":true,"minimum":1,"maximum":24}}},"driverName":{"type":"string","nullable":true}}}}}},"201":{"description":"Order created.","content":{"application/json":{"schema":{"type":"object","required":["id","customer","address","deliveryDate","status","priority"],"properties":{"id":{"type":"string","description":"Ease Your Tasks order id.","example":"6740c9e1a1b2c3d4e5f60718"},"externalId":{"type":"string","nullable":true,"description":"Your stable id. Unique per account. A repeat create with the same externalId returns the original order.","example":"woocommerce:shop.example:1001"},"orderNumber":{"type":"string","nullable":true,"example":"1001"},"source":{"type":"string","nullable":true,"example":"woocommerce"},"customer":{"type":"object","required":["name","phone"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string","nullable":true}}},"address":{"type":"string"},"location":{"type":"object","nullable":true,"properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"deliveryDate":{"type":"string","format":"date","example":"2026-11-08"},"status":{"type":"string","enum":["NotAssigned","Assigned","PathAssigned","SentToDriver","Accepted","OnTheWay","Delivered","Picked","Returned","Failed"]},"priority":{"type":"string"},"items":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"paymentStatus":{"type":"string","nullable":true},"timeWindow":{"type":"object","properties":{"start":{"type":"integer","nullable":true,"minimum":1,"maximum":24},"end":{"type":"integer","nullable":true,"minimum":1,"maximum":24}}},"driverName":{"type":"string","nullable":true}}}}}},"400":{"description":"The body failed validation.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"401":{"description":"The API key is missing, unknown, or revoked.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"402":{"description":"The account has no order credits left.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"403":{"description":"The API key does not have the orders:write scope.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"409":{"description":"The Idempotency-Key was reused with a different body, or that request is still running.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"422":{"description":"The address could not be geocoded.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"429":{"description":"The API key exceeded 120 requests in the current minute.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}}}},"get":{"tags":["Orders"],"operationId":"listOrders","summary":"List delivery orders","description":"Requires deliveryDate or externalId. Results are scoped to the API key's account.","parameters":[{"name":"deliveryDate","in":"query","schema":{"type":"string","format":"date"}},{"name":"externalId","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string","enum":["NotAssigned","Assigned","PathAssigned","SentToDriver","Accepted","OnTheWay","Delivered","Picked","Returned","Failed"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"nextCursor from the previous page."}],"responses":{"200":{"description":"A page of orders.","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","customer","address","deliveryDate","status","priority"],"properties":{"id":{"type":"string","description":"Ease Your Tasks order id.","example":"6740c9e1a1b2c3d4e5f60718"},"externalId":{"type":"string","nullable":true,"description":"Your stable id. Unique per account. A repeat create with the same externalId returns the original order.","example":"woocommerce:shop.example:1001"},"orderNumber":{"type":"string","nullable":true,"example":"1001"},"source":{"type":"string","nullable":true,"example":"woocommerce"},"customer":{"type":"object","required":["name","phone"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string","nullable":true}}},"address":{"type":"string"},"location":{"type":"object","nullable":true,"properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"deliveryDate":{"type":"string","format":"date","example":"2026-11-08"},"status":{"type":"string","enum":["NotAssigned","Assigned","PathAssigned","SentToDriver","Accepted","OnTheWay","Delivered","Picked","Returned","Failed"]},"priority":{"type":"string"},"items":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"paymentStatus":{"type":"string","nullable":true},"timeWindow":{"type":"object","properties":{"start":{"type":"integer","nullable":true,"minimum":1,"maximum":24},"end":{"type":"integer","nullable":true,"minimum":1,"maximum":24}}},"driverName":{"type":"string","nullable":true}}}},"hasMore":{"type":"boolean"},"nextCursor":{"type":"string","nullable":true}}}}}},"400":{"description":"The query failed validation.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"401":{"description":"The API key is missing, unknown, or revoked.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"403":{"description":"The API key does not have the orders:read scope.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}}}}},"/orders/{id}":{"get":{"tags":["Orders"],"operationId":"getOrder","summary":"Read one delivery order","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The order.","content":{"application/json":{"schema":{"type":"object","required":["id","customer","address","deliveryDate","status","priority"],"properties":{"id":{"type":"string","description":"Ease Your Tasks order id.","example":"6740c9e1a1b2c3d4e5f60718"},"externalId":{"type":"string","nullable":true,"description":"Your stable id. Unique per account. A repeat create with the same externalId returns the original order.","example":"woocommerce:shop.example:1001"},"orderNumber":{"type":"string","nullable":true,"example":"1001"},"source":{"type":"string","nullable":true,"example":"woocommerce"},"customer":{"type":"object","required":["name","phone"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string","nullable":true}}},"address":{"type":"string"},"location":{"type":"object","nullable":true,"properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"deliveryDate":{"type":"string","format":"date","example":"2026-11-08"},"status":{"type":"string","enum":["NotAssigned","Assigned","PathAssigned","SentToDriver","Accepted","OnTheWay","Delivered","Picked","Returned","Failed"]},"priority":{"type":"string"},"items":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"paymentStatus":{"type":"string","nullable":true},"timeWindow":{"type":"object","properties":{"start":{"type":"integer","nullable":true,"minimum":1,"maximum":24},"end":{"type":"integer","nullable":true,"minimum":1,"maximum":24}}},"driverName":{"type":"string","nullable":true}}}}}},"401":{"description":"The API key is missing, unknown, or revoked.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"403":{"description":"The API key does not have the orders:read scope.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}},"404":{"description":"No order with this id exists on the account.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"}}}}}}}}}}}}}