Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

handy Orders API

The Orders API from handy — 2 operation(s) for orders.

handy Orders API is one of 4 APIs that handy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 5 operations across 2 paths, and defines 20 schemas. It is described by OpenAPI 2.0, at version v1.

Requests are made against the base URL https://partners.services.handy.com/api/v1.

5 operations 2 paths 20 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1
Base URL
https://partners.services.handy.com/api/v1
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 5
POST
/api/v1/orders
Create Order
4 params → 201400401422409500
GET
/api/v1/orders
Recent Orders
8 params → 200401500
GET
/api/v1/orders/{partner_order_id}
Retrieve Order
4 params → 200401404500
PATCH
/api/v1/orders/{partner_order_id}
Update Order
5 params → 200400403404422500
DELETE
/api/v1/orders/{partner_order_id}
Cancel
5 params → 200400404409500422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are recent_order_product_response (15 properties), order_product_response (15 properties), retrieve_order_response (8 properties), recent_orders_response (8 properties). Each schema is shown below with its type and property counts.

sku
string
The product identifier that has been allocated to the product you are submitting on this order request.
order_creation_params
object
3 properties 3 required
retrieve_order_response
object
8 properties
update_order_req_body
object
Information about the order to update.
2 properties
product_info
object
The information passed in this object will be used to create order product reference objects within our system. These references are then used to provide descr…
3 properties 1 required
address
object
The address of where the service will be performed.
7 properties 3 required
user
object
Details about the user that the order is being created for.
4 properties 4 required
order_details
object
8 properties 1 required
products
array
An array of products associated with the order. A booking is made for each product except in cases of order consolidation. For example, if two products have a…
recent_orders_product_responses
array
order_response
object
8 properties 4 required
order
object
Information about the order to create.
3 properties 2 required
metadata
object
Hash for partner specific information. This is used when partners are using the optional PartnerPurchaseOrder data mapping. Passing in purchaseordernumber as a…
recent_orders_response
object
8 properties
order_product_response
object
15 properties 7 required
recent_order_product_response
object
15 properties
order_details_update
object
1 property 1 required
error_uuid
string
product_responses
array
scheduling_details
object
This is the recommended object where scheduling datetime should be passed in when creating an order. If no datetime is provided in this object or in the proper…
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

handy-orders-api-openapi.yml Raw ↑

Other APIs handy publishes across the network.

handy Bookings API
handy Order Products API
handy Testing API