These docs are for an older version of the API. Click here for the 2.0 API.
API Reference¶
This page is to be used as a reference when developing 3rd party applications for ReadyCloud.
Company Resource¶
GET¶
-
GET/api/v1/company/¶ Retrieve a list of companies.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company/?limit=2&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 2, "next": "/api/v1/company/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&limit=2&offset=2", "offset": 0, "previous": null, "total_count": 3 }, "objects": [ { "company_id": "company_id_3", "created_at": "2014-10-09T15:09:50+00:00", "id": 3, "name": "Company (company_id_3)", "resource_uri": "/api/v1/company/3/", "updated_at": "2014-10-09T15:09:50+00:00" }, { "company_id": "company_new", "created_at": "2014-10-09T15:09:50+00:00", "id": 2, "name": "New Company", "resource_uri": "/api/v1/company/2/", "updated_at": "2014-10-09T15:09:50+00:00" } ] }
-
GET/api/v1/company/(int: id)/¶ Retrieve a single company by id.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the company to get.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 21:41:37 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Language: en-us Content-Type: application/json; charset=utf-8
{ "company_id": "company_new", "created_at": "2014-10-09T15:09:50+00:00", "id": 2, "name": "New Company", "resource_uri": "/api/v1/company/2/", "updated_at": "2014-10-09T15:09:50+00:00" }
POST¶
-
POST/api/v1/company/¶ Create a new company.
Query Parameters: - bearer_token – The token for API access.
Parameters: - company – JSON data that represents a new company to be created.
Status Codes: - 201 – New company was created.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 409 – Company with the company_id supplied already exists.
Example request:
curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/company/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "company_id": "unique_company_id", "created_at": "2010-11-10T03:07:43", "name": "Best Company Ever", "updated_at": "2013-11-10T03:07:43" }
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/company/324235/ Content-Language: en-us
{ "company_id": "unique_company_id", "created_at": "2010-11-10T03:07:43+00:00", "id": 4, "name": "Best Company Ever", "resource_uri": "/api/v1/company/4/", "updated_at": "2013-11-10T03:07:43+00:00" }
PUT¶
-
PUT/api/v1/company/(int: id)/¶ Update an existing company. This action is restricted to users with admin rights for the company.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the company to update or create.
Status Codes: - 201 – New entry was created.
- 202 – Existing entry was updated.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 409 – Company with the company_id supplied already exists.
Example request:
curl -iL --request PUT -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/company/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "company_id": "company_new", "created_at": "2010-11-10T03:07:43", "name": "Old Company", "updated_at": "2012-11-10T03:04:43" }
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
DELETE¶
-
DELETE/api/v1/company/(int: id)/¶ Delete a company. This action is restricted to users with admin rights for the company. If there is only one company for the authenticated user, it can’t be deleted without first creating another company.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – ID not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/company/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us
Company Address Resource¶
GET¶
-
GET/api/v1/company_address/¶ Retrieve a list of company addresses.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company_address/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Fri, 02 Aug 2013 15:50:45 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "address_1": "1234 fake street", "address_2": "Apt# 100", "city": "Idaho", "company": "DateBloggers2", "country": "USA", "created_at": "2011-11-10T03:07:43+00:00", "email": "[email protected]", "first_name": "Joe", "id": 1, "last_name": "Blow", "phone": "12345678910", "post_code": "05324", "residential": true, "resource_uri": "/api/v1/company_address/1/", "state": "Kansas", "true_ship_company": "/api/v1/company/1/", "updated_at": "2013-11-10T03:07:43+00:00", "validated": true } ] }
-
GET/api/v1/company_address/(int: id)/¶ Retrieve a single company address by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The ID of the entry to retrieve.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company_address/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Fri, 02 Aug 2013 15:50:45 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "address_1": "1234 fake street", "address_2": "Apt# 100", "city": "Idaho", "company": "DateBloggers2", "country": "USA", "created_at": "2011-11-10T03:07:43+00:00", "email": "[email protected]", "first_name": "Joe", "id": 1, "last_name": "Blow", "phone": "12345678910", "post_code": "05324", "residential": true, "resource_uri": "/api/v1/company_address/1/", "state": "Kansas", "true_ship_company": "/api/v1/company/1/", "updated_at": "2013-11-10T03:07:43+00:00", "validated": true }
POST¶
-
POST/api/v1/company_address/¶ Create a new company address.
Query Parameters: - bearer_token – The token for API access.
Parameters: - company_address – JSON data representing a new company_address to be created.
Status Codes: - 201 – Company address updated.
- 400 – Company with provided resource uri does not exist.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 409 – Company with another address already exists, cannot override old address.
Example request:
curl -iL --request PUT -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/company_address/2/?bearer_token=f843fa7f67287e600cd7de13992f380b"
data.json:
{ "city": "Idaho", "first_name": "Joe", "last_name": "Blow", "true_ship_company": "/api/v1/company/1/", "country": "USA", "company": "DateBloggers2", "updated_at": "2013-11-10T03:07:43", "email": "[email protected]", "phone": "12345678910", "state": "Kansas", "post_code": "05324", "address_1": "1234 fake street", "address_2": "Apt# 100", "residential": true, "validated": true, "created_at": "2011-11-10T03:07:43" }
Example response:
HTTP/1.0 201 CREATED Date: Wed, 07 Aug 2013 23:28:23 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/company_address/499/ Content-Language: en-us
{ "address_1": "1234 fake street", "address_2": "Apt# 100", "city": "Idaho", "company": "DateBloggers2", "country": "USA", "created_at": "2011-11-10T03:07:43+00:00", "email": "[email protected]", "first_name": "Joe", "id": 1, "last_name": "Blow", "phone": "12345678910", "post_code": "05324", "residential": true, "resource_uri": "/api/v1/company_address/1/", "state": "Kansas", "true_ship_company": "/api/v1/company/1/", "updated_at": "2013-11-10T03:07:43+00:00", "validated": true }
PUT¶
-
PUT/api/v1/company_address/(int: id)/¶ Update an existing company address or create a new one with a specific ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the company address to update or create.
Status Codes: - 200 – Existing entry was updated.
- 201 – New entry was created.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 409 – Company with another address already exists, cannot override old address.
Example request:
curl -iL --request PUT -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/company_address/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "city": "Idaho", "first_name": "Joe", "last_name": "Blow", "true_ship_company": "/api/v1/company/1/", "country": "USA", "company": "DateBloggers2", "updated_at": "2013-11-10T03:07:43", "email": "[email protected]", "phone": "12345678910", "state": "Kansas", "post_code": "05324", "address_1": "1234 fake street", "address_2": "Apt# 100", "residential": true, "validated": true, "created_at": "2011-11-10T03:07:43" }
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
DELETE¶
-
DELETE/api/v1/company_address/(int: id)/¶ Delete a company address.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – ID not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/company_address/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us
Company License Keys Resource¶
GET¶
-
GET/api/v1/company_license_keys/¶ Retrieve a list of company license keys.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company_license_keys/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:21:24 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "is_company_admin": false, "is_super_user": false, "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 2 }, "objects": [ { "code": "1111-XXXX-XXXX-XXXX-1111", "resource_uri": "/api/v1/company_license_keys/2/" }, { "code": "2222-XXXX-XXXX-XXXX-222", "resource_uri": "/api/v1/company_license_keys/1/" } ] }
-
GET/api/v1/company_license_keys/(int: id)/¶ Retrieve a single company license key by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The id of the entry to retrieve.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company_license_keys/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:29:25 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "code": "2222-XXXX-XXXX-XXXX-222", "resource_uri": "/api/v1/company_license_keys/1/" }
Company Members Resource¶
GET¶
-
GET/api/v1/company_members/¶ Retrieve a list of company members.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company_members/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:21:24 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "is_company_admin": false, "is_company_owner": false, "limit": 1000, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "avatar": "https://secure.gravatar.com/avatar/d4c74594d841139328695756648b6bd6?size=30", "email": "[email protected]", "id": 1, "is_active": true, "is_admin": false, "is_owner": false, "is_superuser": false, "name": "John Example", "resource_uri": "/api/v1/company_members/1/" } ] }
-
GET/api/v1/company_members/(int: id)/¶ Retrieve a single company member by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The ID of the entry to retrieve.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/company_members/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:29:25 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "avatar": "https://secure.gravatar.com/avatar/d4c74594d841139328695756648b6bd6?size=30", "email": "[email protected]", "id": 1, "is_active": true, "is_admin": false, "is_owner": false, "is_superuser": false, "name": "John Example", "resource_uri": "/api/v1/company_members/1/" }
Order Resource¶
GET¶
-
GET/api/v1/orders/¶ Retrieve a list of orders.
This collection can be filtered by one of the following fields: ‘id, backup, order_time, import_time, ship_time, future_ship_time, print_time, ship_via, ship_type, customer_number, source, updated_at, created_at, numerical_id, primary_id, status_shipped’. The following operators sre available: ‘lte, gte, range’ or ‘=’. When filtering by date, use an ISO 8601 formatted date.
This collection can be expanded with additional inline data using the “expand” parameter. For example, to retrieve full details on boxes within the order, ‘expand=boxes’ might be used. Available expansions are: boxes, boxes__items, all.
Query Parameters: - bearer_token – The token for API access.
Parameters: - format – Expected format (JSON or XML).
- limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
- expand – Comma separated list of embedded resources to expand with full detail.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/orders/?format=json&limit=3&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&ship_time__lte=2014-05-13T12:48:04.825473"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 3, "next": null, "offset": 0, "previous": null, "total_count": 2 }, "objects": [ { "bill_to": { "resource_uri": "/api/v1/addresses/4/" }, "boxes": [ { "resource_uri": "/api/v1/boxes/3/" } ], "charges": { "actual_shipcost": "200.00 USD", "calculated_grand_total": "200.00 USD", "calculated_shipping": "200.00 USD", "calculated_tax": "200.00 USD", "calculated_total": "200.00 USD", "grand_total": "200.00 USD", "grand_total_source": "imported", "imported_grand_total": "200.00 USD", "imported_shipping": "200.00 USD", "imported_tax": "200.00 USD", "imported_total": "200.00 USD", "shipping": "200.00 USD", "shipping_source": "imported", "tax": "200.00 USD", "tax_source": "imported", "total": "200.00 USD", "total_source": "imported" }, "created_at": "2014-10-09T16:21:10+00:00", "custom_fields": [ { "resource_uri": "/api/v1/order_custom_fields/2/" } ], "customer_number": "CN-14", "future_ship_at": "2012-01-09T01:24:59+00:00", "imported_at": "2012-01-07T01:24:59+00:00", "message": "Order message", "numerical_id": 14, "order_time": "2012-01-07T01:24:59+00:00", "po_number": "PO-14", "primary_id": "14", "printed_at": "2012-01-07T01:24:59+00:00", "resource_uri": "/api/v1/orders/2/", "revision_id": null, "revisions_resource_uri": "/api/v1/orders/2/revisions/", "ship_from": { "resource_uri": "/api/v1/addresses/6/" }, "ship_time": "2014-05-12T11:48:04+00:00", "ship_to": { "resource_uri": "/api/v1/addresses/5/" }, "ship_type": "Standard", "ship_via": "Mail Innovations", "source": "Shopify", "sources": [ { "account": "shirts-store", "channel": null, "created_at": "2012-01-07T01:24:59+00:00", "name": "Shopify", "order": "/api/v1/orders/2/", "order_source_id": "300021", "resource_uri": "/api/v1/order_source/2/", "retrieved_at": "2012-01-07T01:24:59+00:00", "updated_at": "2012-01-07T01:24:59+00:00" } ], "status_shipped": false, "terms": "Order test terms", "unique_id": "00002vBtLSBCD2yzMRJ301Z6", "updated_at": "2014-10-09T16:21:10+00:00", "warehouse": "test warehouse" }, { "bill_to": { "resource_uri": "/api/v1/addresses/1/" }, "boxes": [ { "resource_uri": "/api/v1/boxes/1/" }, { "resource_uri": "/api/v1/boxes/2/" } ], "charges": { "actual_shipcost": "100.00 USD", "calculated_grand_total": "100.00 USD", "calculated_shipping": "100.00 USD", "calculated_tax": "100.00 USD", "calculated_total": "100.00 USD", "grand_total": "100.00 USD", "grand_total_source": "imported", "imported_grand_total": "100.00 USD", "imported_shipping": "100.00 USD", "imported_tax": "100.00 USD", "imported_total": "100.00 USD", "shipping": "100.00 USD", "shipping_source": "imported", "tax": "100.00 USD", "tax_source": "imported", "total": "100.00 USD", "total_source": "imported" }, "created_at": "2014-10-09T16:21:10+00:00", "custom_fields": [ { "resource_uri": "/api/v1/order_custom_fields/1/" } ], "customer_number": "CN-13", "future_ship_at": "2012-01-09T01:24:59+00:00", "imported_at": "2012-01-07T01:24:59+00:00", "message": "Order message", "numerical_id": 13, "order_time": "2012-01-07T01:24:59+00:00", "po_number": "PO-13", "primary_id": "13", "printed_at": "2012-01-07T01:24:59+00:00", "resource_uri": "/api/v1/orders/1/", "revision_id": null, "revisions_resource_uri": "/api/v1/orders/1/revisions/", "ship_from": { "resource_uri": "/api/v1/addresses/3/" }, "ship_time": "2014-05-12T11:48:04+00:00", "ship_to": { "resource_uri": "/api/v1/addresses/2/" }, "ship_type": "UPS Ground", "ship_via": "New Mail", "source": "UPS", "sources": [ { "account": null, "channel": null, "created_at": "2012-01-07T01:24:59+00:00", "name": "UPS", "order": "/api/v1/orders/1/", "order_source_id": null, "resource_uri": "/api/v1/order_source/1/", "retrieved_at": "2012-01-07T01:24:59+00:00", "updated_at": "2012-01-07T01:24:59+00:00" } ], "status_shipped": true, "terms": "Order test terms", "unique_id": "00002vBtLSBCD2yzMRJ301Z5", "updated_at": "2014-10-09T16:21:10+00:00", "warehouse": "test warehouse" } ] }
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/orders/?format=json&limit=1&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&expand=boxes"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 1, "next": "/api/v1/orders/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&offset=1&limit=1&expand=boxes&format=json", "offset": 0, "previous": null, "total_count": 3 }, "objects": [ { "bill_to": { "resource_uri": "/api/v1/addresses/7/" }, "boxes": [ { "charges": { "actual_ship_cost": "134.56 USD", "declared_value": "93.10 USD", "insured_value": "87.90 USD" }, "custom_fields": [ { "resource_uri": "/api/v1/box_custom_fields/6/" } ], "delivery_confirmation": "signature_required", "general_description": "Green widget", "height": "10.0000", "items": [ { "resource_uri": "/api/v1/items/4/" } ], "length": "10.0000", "order": "/api/v1/orders/3/", "resource_uri": "/api/v1/boxes/4/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "EJ958088694US", "weight": "165.0000", "width": "10.0000" } ], "charges": { "actual_shipcost": "300.00 USD", "calculated_grand_total": "300.00 USD", "calculated_shipping": "300.00 USD", "calculated_tax": "300.00 USD", "calculated_total": "300.00 USD", "grand_total": "300.00 USD", "grand_total_source": "imported", "imported_grand_total": "300.00 USD", "imported_shipping": "300.00 USD", "imported_tax": "300.00 USD", "imported_total": "300.00 USD", "shipping": "300.00 USD", "shipping_source": "imported", "tax": "300.00 USD", "tax_source": "imported", "total": "300.00 USD", "total_source": "imported" }, "created_at": "2014-10-09T16:21:10+00:00", "custom_fields": [ { "resource_uri": "/api/v1/order_custom_fields/3/" } ], "customer_number": "CN-15", "future_ship_at": "2012-01-09T01:24:59+00:00", "imported_at": "2012-01-07T01:24:59+00:00", "message": "Order message", "numerical_id": 15, "order_time": "2012-01-07T01:24:59+00:00", "po_number": "PO-15", "primary_id": "15", "printed_at": "2012-01-07T01:24:59+00:00", "resource_uri": "/api/v1/orders/3/", "revision_id": null, "revisions_resource_uri": "/api/v1/orders/3/revisions/", "ship_from": { "resource_uri": "/api/v1/addresses/9/" }, "ship_time": "2014-10-12T11:48:04+00:00", "ship_to": { "resource_uri": "/api/v1/addresses/8/" }, "ship_type": "Priority", "ship_via": "Form Only", "source": "FedEx", "sources": [ { "account": null, "channel": null, "created_at": "2012-01-07T01:24:59+00:00", "name": "FedEx", "order": "/api/v1/orders/3/", "order_source_id": null, "resource_uri": "/api/v1/order_source/3/", "retrieved_at": "2012-01-07T01:24:59+00:00", "updated_at": "2012-01-07T01:24:59+00:00" } ], "status_shipped": true, "terms": "Order test terms", "unique_id": "00002vBtLSBCD2yzMRJ301Z7", "updated_at": "2014-10-09T16:21:10+00:00", "warehouse": "test warehouse" } ] }
-
GET/api/v1/orders/(int: id)/¶ Retrieve a single order by ID.
This detail resource can be expanded with additional inline data using the “expand” parameter. For example, to retrieve full details on boxes within the order, ‘expand=boxes’ might be used. Available expansions are: boxes, boxes__items, all.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the order to get.
- expand – Comma separated list of embedded resources to expand with full detail.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/orders/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&expand=boxes,boxes__items"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 21:41:37 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Language: en-us Content-Type: application/json; charset=utf-8
{ "bill_to": { "resource_uri": "/api/v1/addresses/7/" }, "boxes": [ { "charges": { "actual_ship_cost": "134.56 USD", "declared_value": "93.10 USD", "insured_value": "87.90 USD" }, "custom_fields": [ { "resource_uri": "/api/v1/box_custom_fields/6/" } ], "delivery_confirmation": "signature_required", "general_description": "Green widget", "height": "10.0000", "items": [ { "box": "/api/v1/boxes/4/", "charges": { "unit_price": "154.00 USD" }, "commodity_code": "C-20", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": "20", "joint_production": true, "net_cost_begin_date": "2013-08-01T20:54:27+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2013-08-03T20:54:27+00:00", "origin_country_code": "US", "part_number": "PN-4", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[3]", "quantity": 3, "resource_uri": "/api/v1/items/4/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "184.0000", "url": "http://box.url" } ], "length": "10.0000", "order": "/api/v1/orders/3/", "resource_uri": "/api/v1/boxes/4/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "EJ958088694US", "weight": "165.0000", "width": "10.0000" } ], "charges": { "actual_shipcost": "300.00 USD", "calculated_grand_total": "300.00 USD", "calculated_shipping": "300.00 USD", "calculated_tax": "300.00 USD", "calculated_total": "300.00 USD", "grand_total": "300.00 USD", "grand_total_source": "imported", "imported_grand_total": "300.00 USD", "imported_shipping": "300.00 USD", "imported_tax": "300.00 USD", "imported_total": "300.00 USD", "shipping": "300.00 USD", "shipping_source": "imported", "tax": "300.00 USD", "tax_source": "imported", "total": "300.00 USD", "total_source": "imported" }, "created_at": "2014-10-09T16:21:10+00:00", "custom_fields": [ { "resource_uri": "/api/v1/order_custom_fields/3/" } ], "customer_number": "CN-15", "future_ship_at": "2012-01-09T01:24:59+00:00", "imported_at": "2012-01-07T01:24:59+00:00", "message": "Order message", "numerical_id": 15, "order_time": "2012-01-07T01:24:59+00:00", "po_number": "PO-15", "primary_id": "15", "printed_at": "2012-01-07T01:24:59+00:00", "resource_uri": "/api/v1/orders/3/", "revision_id": null, "revisions_resource_uri": "/api/v1/orders/3/revisions/", "ship_from": { "resource_uri": "/api/v1/addresses/9/" }, "ship_time": "2014-10-12T11:48:04+00:00", "ship_to": { "resource_uri": "/api/v1/addresses/8/" }, "ship_type": "Priority", "ship_via": "Form Only", "source": "FedEx", "sources": [ { "account": null, "channel": null, "created_at": "2012-01-07T01:24:59+00:00", "name": "FedEx", "order": "/api/v1/orders/3/", "order_source_id": null, "resource_uri": "/api/v1/order_source/3/", "retrieved_at": "2012-01-07T01:24:59+00:00", "updated_at": "2012-01-07T01:24:59+00:00" } ], "status_shipped": true, "terms": "Order test terms", "updated_at": "2014-10-09T16:21:10+00:00", "unique_id": "00002vBtLSBCD2yzMRJ301Z7", "warehouse": "test warehouse" }
POST¶
-
POST/api/v1/orders/¶ Create a new order.
Query Parameters: - bearer_token – The token for API access.
Parameters: - order – JSON data representing a new order to be created.
Status Codes: - 201 – New order was created.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/orders/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "bill_to": { "a_type": "bill", "address_1": "2010 Warsaw Rd", "address_2": "Apt 4", "city": "Roswell", "company": "UPS", "country": "United States", "email": "[email protected]", "first_name": "Pat", "last_name": "Test", "phone": "6785851113", "post_code": "56001", "residential": false, "state": "Georgia", "validated": false }, "boxes": [ { "charges": { "actual_ship_cost": "22.00 USD", "declared_value": "190.00 USD", "insured_value": "120.00 USD" }, "custom_fields": [ { "name": "Export", "value": "7" }, { "name": "Gift", "value": "8" } ], "delivery_confirmation": "signature_required", "general_description": "Red widget", "items": [ { "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "joint_production": true, "net_cost_begin_date": "2014-01-21 14:58:52", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23 14:58:52", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "scheduleb_commodity_code": "SCC-5", "charges": { "unit_price": "112.00 USD" }, "unit_weight": "20.0000", "url": "http://box.url" } ], "saturday_delivery": true, "shipper_release": true, "tracking_number": "EJ958083578US", "weight": "68.0000" }, { "charges": { "actual_ship_cost": "95.00 USD", "declared_value": "194.00 USD", "insured_value": "46.00 USD" }, "custom_fields": [ { "name": "Gift", "value": "5" }, { "name": "Check", "value": "6" } ], "delivery_confirmation": "signature_required", "general_description": "Blue widget", "items": [ { "commodity_code": "C-3", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "joint_production": true, "net_cost_begin_date": "2014-01-21 14:58:52", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23 14:58:52", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[3]", "quantity": 3, "scheduleb_commodity_code": "SCC-5", "charges": { "unit_price": "94.00 USD" }, "unit_weight": "36.0000", "url": "http://box.url" } ], "saturday_delivery": true, "shipper_release": true, "tracking_number": "1Z12345E0390515214", "weight": "183.0000" } ], "charges": { "actual_shipcost": "108.00 USD", "calculated_grand_total": "197.00 USD", "calculated_shipping": "193.00 USD", "calculated_tax": "36.00 USD", "calculated_total": "89.00 USD", "grand_total": "162.00 USD", "grand_total_source": "imported", "imported_grand_total": "157.00 USD", "imported_shipping": "132.00 USD", "imported_tax": "88.00 USD", "imported_total": "76.00 USD", "shipping": "192.00 USD", "shipping_source": "imported", "tax": "80.00 USD", "tax_source": "imported", "total": "190.00 USD", "total_source": "imported" }, "custom_fields": [ { "name": "Gift", "value": "2" } ], "customer_number": "CN-2", "future_ship_time": "2014-01-21 04:17:43", "message": "Order message", "numerical_id": "2", "order_time": "2014-01-19 04:17:43", "po_number": "PO-2", "primary_id": "2", "print_time": "2014-01-19 04:17:43", "ship_from": { "a_type": "from", "address_1": "8449 E Edgemont", "address_2": "Apt 4", "city": "New York", "company": "FedEx", "country": "United States", "email": "[email protected]", "first_name": "Ann", "last_name": "Test", "phone": "6785851113", "post_code": "10019", "residential": false, "state": "NY", "validated": false }, "ship_time": "2014-01-28 15:55:10", "ship_to": { "a_type": "destination", "address_1": "900 Lincoln Dr", "address_2": "Apt 4", "city": "Scottsdale", "company": "USPS", "country": "United States", "email": "[email protected]", "first_name": "Nick", "last_name": "Test", "phone": "6785851113", "post_code": "85257", "residential": false, "state": "AZ", "validated": false }, "ship_type": "Delivery Confirmation", "ship_via": "Mail Innovations", "sources": [ { "name": "USPS", "retrieved_at": "2014-01-19 04:17:43" } ], "status_shipped": false, "terms": "Order test terms", "unique_id": "00002vBudIpvffTITvUW6fMm", "warehouse": "test warehouse" }
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/orders/324235/ Content-Language: en-us
{ "bill_to": { "a_type": "bill", "address_1": "2010 Warsaw Rd", "address_2": "Apt 4", "city": "Roswell", "company": "UPS", "country": "United States", "email": "[email protected]", "first_name": "Pat", "last_name": "Test", "order": "/api/v1/orders/4/", "phone": "6785851113", "post_code": "56001", "residential": false, "resource_uri": "/api/v1/addresses/10/", "state": "Georgia", "validated": false }, "boxes": [ { "charges": { "actual_ship_cost": "22.00 USD", "declared_value": "190.00 USD", "insured_value": "120.00 USD" }, "custom_fields": [ { "box": "/api/v1/boxes/5/", "created_at": "2014-10-08T07:24:04+00:00", "id": 7, "name": "Export", "resource_uri": "/api/v1/box_custom_fields/7/", "updated_at": "2014-10-08T07:24:04+00:00", "value": "7" }, { "box": "/api/v1/boxes/5/", "created_at": "2014-10-08T07:24:04+00:00", "id": 8, "name": "Gift", "resource_uri": "/api/v1/box_custom_fields/8/", "updated_at": "2014-10-08T07:24:04+00:00", "value": "8" } ], "delivery_confirmation": "signature_required", "general_description": "Red widget", "height": null, "items": [ { "box": "/api/v1/boxes/5/", "charges": { "unit_price": "112.00 USD" }, "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": null, "joint_production": true, "net_cost_begin_date": "2014-01-21T14:58:52+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23T14:58:52+00:00", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "resource_uri": "/api/v1/items/5/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "20.0000", "url": "http://box.url" } ], "length": null, "order": "/api/v1/orders/4/", "resource_uri": "/api/v1/boxes/5/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "EJ958083578US", "weight": "68.0000", "width": null }, { "charges": { "actual_ship_cost": "95.00 USD", "declared_value": "194.00 USD", "insured_value": "46.00 USD" }, "custom_fields": [ { "box": "/api/v1/boxes/6/", "created_at": "2014-10-08T07:24:04+00:00", "id": 9, "name": "Gift", "resource_uri": "/api/v1/box_custom_fields/9/", "updated_at": "2014-10-08T07:24:04+00:00", "value": "5" }, { "box": "/api/v1/boxes/6/", "created_at": "2014-10-08T07:24:04+00:00", "id": 10, "name": "Check", "resource_uri": "/api/v1/box_custom_fields/10/", "updated_at": "2014-10-08T07:24:04+00:00", "value": "6" } ], "delivery_confirmation": "signature_required", "general_description": "Blue widget", "height": null, "items": [ { "box": "/api/v1/boxes/6/", "charges": { "unit_price": "94.00 USD" }, "commodity_code": "C-3", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": null, "joint_production": true, "net_cost_begin_date": "2014-01-21T14:58:52+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23T14:58:52+00:00", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[3]", "quantity": 3, "resource_uri": "/api/v1/items/6/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "36.0000", "url": "http://box.url" } ], "length": null, "order": "/api/v1/orders/4/", "resource_uri": "/api/v1/boxes/6/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "1Z12345E0390515214", "weight": "183.0000", "width": null } ], "charges": { "actual_shipcost": "108.00 USD", "calculated_grand_total": "197.00 USD", "calculated_shipping": "193.00 USD", "calculated_tax": "36.00 USD", "calculated_total": "89.00 USD", "grand_total": "162.00 USD", "grand_total_source": "imported", "imported_grand_total": "157.00 USD", "imported_shipping": "132.00 USD", "imported_tax": "88.00 USD", "imported_total": "76.00 USD", "shipping": "192.00 USD", "shipping_source": "imported", "tax": "80.00 USD", "tax_source": "imported", "total": "190.00 USD", "total_source": "imported" }, "created_at": "2014-10-08T07:24:04+00:00", "custom_fields": [ { "created_at": "2014-10-08T07:24:04+00:00", "id": 4, "name": "Gift", "order": "/api/v1/orders/4/", "resource_uri": "/api/v1/order_custom_fields/4/", "updated_at": "2014-10-08T07:24:04+00:00", "value": "2" } ], "customer_number": "CN-2", "future_ship_at": null, "imported_at": "2014-01-19T04:17:43+00:00", "message": "Order message", "numerical_id": 2, "order_time": "2014-01-19T04:17:43+00:00", "po_number": "PO-2", "primary_id": "2", "printed_at": null, "resource_uri": "/api/v1/orders/4/", "revision_id": 1, "revisions_resource_uri": "/api/v1/orders/4/revisions/", "ship_from": { "a_type": "from", "address_1": "8449 E Edgemont", "address_2": "Apt 4", "city": "New York", "company": "FedEx", "country": "United States", "email": "[email protected]", "first_name": "Ann", "last_name": "Test", "order": "/api/v1/orders/4/", "phone": "6785851113", "post_code": "10019", "residential": false, "resource_uri": "/api/v1/addresses/12/", "state": "NY", "validated": false }, "ship_time": "2014-01-28T15:55:10+00:00", "ship_to": { "a_type": "destination", "address_1": "900 Lincoln Dr", "address_2": "Apt 4", "city": "Scottsdale", "company": "USPS", "country": "United States", "email": "[email protected]", "first_name": "Nick", "last_name": "Test", "order": "/api/v1/orders/4/", "phone": "6785851113", "post_code": "85257", "residential": false, "resource_uri": "/api/v1/addresses/11/", "state": "AZ", "validated": false }, "ship_type": "Delivery Confirmation", "ship_via": "Mail Innovations", "source": "USPS", "sources": [ { "account": null, "channel": null, "name": "USPS", "order": "/api/v1/orders/4/", "order_source_id": null, "resource_uri": "/api/v1/order_source/5/", "retrieved_at": "2014-01-19T04:17:43+00:00" } ], "status_shipped": false, "terms": "Order test terms", "unique_id": "00002vBudIpvffTITvUW6fMm", "warehouse": "test warehouse", "updated_at": "2014-10-08T07:24:04+00:00" }
PUT¶
PUT works the same as the PATCH method in this API. See the documentation for PATCH method for more detail.
PATCH¶
-
PATCH/api/v1/orders/(int: id)/¶ Update an existing order.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the order to update or create.
Status Codes: - 202 – Entry was updated.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry with provided ID not found.
Example request:
curl -iL --request PATCH -H "Content-Type: application/json" --data '{"message": "New Order message", "boxes": [{"pk": 12, "tracking_number": "New tracking number"}]}' "https://www.readycloud.com/api/v1/orders/6/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "bill_to": { "a_type": "bill", "address_1": "2010 Warsaw Rd", "address_2": "Apt 4", "city": "Roswell", "company": "UPS", "country": "United States", "email": "oｒｒíｃｏ@mail.com", "first_name": "Pat", "last_name": "Oｒｒíｃｏ", "order": "/api/v1/orders/3/", "phone": "6785851113", "post_code": "56001", "residential": false, "resource_uri": "/api/v1/addresses/7/", "state": "Georgia", "validated": false }, "boxes": [ { "charges": { "actual_ship_cost": "134.56 USD", "declared_value": "93.10 USD", "insured_value": "87.90 USD" }, "custom_fields": [ { "box": "/api/v1/boxes/4/", "created_at": "2014-10-08T11:25:32+00:00", "id": 6, "name": "Check", "resource_uri": "/api/v1/box_custom_fields/6/", "updated_at": "2014-10-08T11:25:32+00:00", "value": "6" } ], "delivery_confirmation": "signature_required", "general_description": "Red widget", "height": "10.0000", "items": [ { "box": "/api/v1/boxes/4/", "charges": { "unit_price": "154.00 USD" }, "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": "4", "joint_production": true, "net_cost_begin_date": "2013-08-01T20:54:27+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2013-08-03T20:54:27+00:00", "origin_country_code": "US", "part_number": "PN-4", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[3]", "quantity": 3, "resource_uri": "/api/v1/items/4/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "184.0000", "url": "http://box.url" } ], "length": "10.0000", "order": "/api/v1/orders/3/", "resource_uri": "/api/v1/boxes/4/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "New tracking number", "weight": "165.0000", "width": "10.0000" } ], "charges": { "actual_shipcost": "300.00 USD", "calculated_grand_total": "300.00 USD", "calculated_shipping": "300.00 USD", "calculated_tax": "300.00 USD", "calculated_total": "300.00 USD", "grand_total": "300.00 USD", "grand_total_source": "imported", "imported_grand_total": "300.00 USD", "imported_shipping": "300.00 USD", "imported_tax": "300.00 USD", "imported_total": "300.00 USD", "shipping": "300.00 USD", "shipping_source": "imported", "tax": "300.00 USD", "tax_source": "imported", "total": "300.00 USD", "total_source": "imported" }, "created_at": "2014-10-08T11:25:32+00:00", "custom_fields": [ { "created_at": "2014-10-08T11:25:32+00:00", "id": 3, "name": "Check", "order": "/api/v1/orders/3/", "resource_uri": "/api/v1/order_custom_fields/3/", "updated_at": "2014-10-08T11:25:33+00:00", "value": "3" } ], "customer_number": "CN-3", "future_ship_at": "2012-01-09T01:24:59+00:00", "imported_at": "2012-01-07T01:24:59+00:00", "message": "New Order message", "numerical_id": 3, "order_time": "2012-01-07T01:24:59+00:00", "po_number": "PO-3", "primary_id": "3", "printed_at": "2012-01-07T01:24:59+00:00", "resource_uri": "/api/v1/orders/3/", "revision_id": 1, "revisions_resource_uri": "/api/v1/orders/3/revisions/", "ship_from": { "a_type": "from", "address_1": "8449 E Edgemont", "address_2": "Apt 4", "city": "New York", "company": "FedEx", "country": "United States", "email": "sϻｉｔɦ@mail.com", "first_name": "Ann", "last_name": "Sϻｉｔɦ", "order": "/api/v1/orders/3/", "phone": "6785851113", "post_code": "10019", "residential": false, "resource_uri": "/api/v1/addresses/9/", "state": "NY", "validated": null }, "ship_time": "2014-10-12T11:48:04+00:00", "ship_to": { "a_type": "destination", "address_1": "900 Lincoln Dr", "address_2": "Apt 4", "city": "Scottsdale", "company": "USPS", "country": "United States", "email": "jåｂｒ߀@mail.com", "first_name": "Nick", "last_name": "Jåｂｒ߀", "order": "/api/v1/orders/3/", "phone": "6785851113", "post_code": "85257", "residential": false, "resource_uri": "/api/v1/addresses/8/", "state": "AZ", "validated": true }, "ship_type": "UPS Ground", "ship_via": "Form Only", "source": "FedEx", "status_shipped": true, "terms": "Order test terms", "updated_at": "2014-10-08T11:25:33+00:00" }
DELETE¶
-
DELETE/api/v1/orders/(int: id)/¶ Delete an order.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Order not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/orders/6/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us
Order Address Resource¶
GET¶
-
GET/api/v1/orders/(int: id)/addresses/ or /api/v1/addresses/¶ Retrieve a list of order addresses.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
- id – The ID of the order to retrieve.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/addresses/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Fri, 02 Aug 2013 15:50:45 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 3 }, "objects": [ { "a_type": "from", "address_1": "8449 E Edgemont", "address_2": "Apt 4", "city": "New York", "company": "FedEx", "country": "United States", "email": "sϻｉｔɦ@mail.com", "first_name": "Ann", "last_name": "Sϻｉｔɦ", "order": "/api/v1/orders/1/", "phone": "6785851113", "post_code": "10019", "residential": false, "resource_uri": "/api/v1/addresses/3/", "state": "NY", "validated": null }, { "a_type": "destination", "address_1": "900 Lincoln Dr", "address_2": "Apt 4", "city": "Scottsdale", "company": "USPS", "country": "United States", "email": "jåｂｒ߀@mail.com", "first_name": "Nick", "last_name": "Jåｂｒ߀", "order": "/api/v1/orders/1/", "phone": "6785851113", "post_code": "85257", "residential": false, "resource_uri": "/api/v1/addresses/2/", "state": "AZ", "validated": true }, { "a_type": "bill", "address_1": "2010 Warsaw Rd", "address_2": "Apt 4", "city": "Roswell", "company": "UPS", "country": "United States", "email": "oｒｒíｃｏ@mail.com", "first_name": "Pat", "last_name": "Oｒｒíｃｏ", "order": "/api/v1/orders/1/", "phone": "6785851113", "post_code": "56001", "residential": false, "resource_uri": "/api/v1/addresses/1/", "state": "Georgia", "validated": false } ] }
-
GET/api/v1/orders/(int: order_id)/(str: a_type) or /api/v1/addresses/(int: id)¶ Retrieve an order address.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The ID of the entry to retrieve.
- order_id – The ID of the order to retrieve.
- a_type – The type of the address to retrieve – one of “ship_address”, “bill_address” or “from_address”.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/addresses/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Fri, 02 Aug 2013 15:50:45 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "a_type": "bill", "address_1": "2010 Warsaw Rd", "address_2": "Apt 4", "city": "Roswell", "company": "UPS", "country": "United States", "email": "oｒｒíｃｏ@mail.com", "first_name": "Pat", "last_name": "Oｒｒíｃｏ", "order": "/api/v1/orders/1/", "phone": "6785851113", "post_code": "56001", "residential": false, "resource_uri": "/api/v1/addresses/1/", "state": "Georgia", "validated": false }
POST¶
-
POST/api/v1/orders/(int: order_id)/addresses/¶ Create a new order address.
Query Parameters: - bearer_token – The token for API access.
Parameters: - order_id – ID of the order to update or create an address for.
Status Codes: - 201 – New entry was created.
- 202 – Existing entry was updated.
- 400 – Wrong address type or address for this order already exists.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Order entry not found.
- 405 – Can’t override address type.
Example request:
curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com /api/v1/orders/1/addresses/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "city": "Idaho", "first_name": "Joe", "last_name": "Blow", "country": "USA", "company": "DateBloggers2", "updated_at": "2013-11-10T03:07:43", "email": "[email protected]", "phone": "12345678910", "state": "Kansas", "post_code": "05324", "address_1": "1234 fake street", "address_2": "Apt# 100", "a_type": "bill", "created_at": "2011-11-10T03:07:43" }
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "a_type": "bill", "address_1": "1234 fake street", "address_2": "Apt# 100", "city": "Idaho", "company": "DateBloggers2", "country": "USA", "created_at": "2011-11-10T03:07:43", "email": "[email protected]", "first_name": "Joe", "last_name": "Blow", "order": "/api/v1/orders/1/", "phone": "12345678910", "post_code": "05324", "residential": null, "resource_uri": "/api/v1/addresses/4/", "state": "Kansas", "updated_at": "2013-11-10T03:07:43", "validated": false }
PUT¶
-
PUT/api/v1/orders/(int: order_id)/(str: a_type) or /api/v1/addresses/(int: id)¶ Update an existing order address or create a new one with a specific ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the address to update or create.
- order_id – ID of the order to update an address for.
- a_type – The type of the address to retrieve – one of “ship_address”, “bill_address” and “from_address”.
Status Codes: - 200 – New entry was created or existing entry was updated.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Order entry not found.
- 405 – Can’t override address type.
Example request:
curl -iL --request PUT -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/addresses/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "city": "Idaho", "first_name": "Joe", "last_name": "Blow", "country": "USA", "company": "DateBloggers2", "updated_at": "2013-11-10T03:07:43", "email": "[email protected]", "phone": "12345678910", "state": "Kansas", "post_code": "05324", "address_1": "1234 fake street", "address_2": "Apt# 100", "residential": true, "a_type": "from", "validated": true, "created_at": "2011-11-10T03:07:43" }
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "a_type": "from", "address_1": "1234 fake street", "address_2": "Apt# 100", "city": "Idaho", "company": "DateBloggers2", "country": "USA", "created_at": "2011-11-10T03:07:43", "email": "[email protected]", "first_name": "Joe", "last_name": "Blow", "order": "/api/v1/orders/1/", "phone": "12345678910", "post_code": "05324", "residential": true, "resource_uri": "/api/v1/addresses/3/", "state": "Kansas", "updated_at": "2013-11-10T03:07:43", "validated": true }
DELETE¶
-
DELETE/api/v1/addresses/(int: id)/¶ Delete an order address.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – ID not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/addresses/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us
Box Resource¶
GET¶
-
GET/api/v1/boxes/ or /api/v1/orders/(int: order)/boxes/¶ Retrieve a list of boxes.
The delivery_confirmation field has the following possible values:
- none - Disable delivery confirmation.
- no_signature_required - Delivery confirmation requested.
- signature_required - Delivery confirmation requested, and also require a signature.
- adult_signature_required - Delivery confirmation request, and also require an adult signature.
This collection can be expanded with additional inline data using the “expand” parameter. For example, to retrieve full details on items within the boxes, ‘expand=items’ might be used. Available expansions are: items, custom_fields, all.
All weight values are specified in grams. All length values are specified in meters.
Query Parameters: - bearer_token – The token for API access.
Parameters: - format – Expected format (JSON or XML).
- limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
- expand – Comma separated list of embedded resources to expand with full detail.
- order – Order ID for which you want retrieve boxes.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/boxes/?format=json&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&order=1"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 2 }, "objects": [ { "charges": { "actual_ship_cost": "107.00 USD", "declared_value": "72.00 USD", "insured_value": "106.00 USD" }, "custom_fields": [ { "resource_uri": "/api/v1/box_custom_fields/3/" }, { "resource_uri": "/api/v1/box_custom_fields/4/" } ], "delivery_confirmation": "signature_required", "general_description": "Blue widget", "height": "10.0000", "items": [ { "resource_uri": "/api/v1/items/2/" } ], "length": "10.0000", "order": "/api/v1/orders/1/", "resource_uri": "/api/v1/boxes/2/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "1Z12345E0390515214", "weight": "100.0000", "width": "10.0000" }, { "charges": { "actual_ship_cost": "124.00 USD", "declared_value": "88.00 USD", "insured_value": "104.00 USD" }, "custom_fields": [ { "resource_uri": "/api/v1/box_custom_fields/1/" }, { "resource_uri": "/api/v1/box_custom_fields/2/" } ], "delivery_confirmation": "signature_required", "general_description": "Green widget", "height": "10.0000", "items": [ { "resource_uri": "/api/v1/items/1/" } ], "length": "10.0000", "order": "/api/v1/orders/1/", "resource_uri": "/api/v1/boxes/1/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "EJ958088694US", "weight": "29.0000", "width": "10.0000" } ] }
-
GET/api/v1/boxes/(int: id)/¶ Retrieve a single box by ID
This detail resource be expanded with additional inline data using the “expand” parameter. For example, to retrieve full details on items within the box, ‘expand=items’ might be used. Available expansions are: items, custom_fields, all.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the box to get.
- expand – Comma separated list of embedded resources to expand with full detail.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/boxes/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 21:41:37 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Language: en-us Content-Type: application/json; charset=utf-8
{ "charges": { "actual_ship_cost": "124.00 USD", "declared_value": "88.00 USD", "insured_value": "104.00 USD" }, "custom_fields": [ { "resource_uri": "/api/v1/box_custom_fields/1/" }, { "resource_uri": "/api/v1/box_custom_fields/2/" } ], "delivery_confirmation": "signature_required", "general_description": "Green widget", "height": "10.0000", "items": [ { "resource_uri": "/api/v1/items/1/" } ], "length": "10.0000", "order": "/api/v1/orders/1/", "resource_uri": "/api/v1/boxes/1/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "EJ958088694US", "weight": "29.0000", "width": "10.0000" }
POST¶
-
POST/api/v1/boxes/ or /api/v1/orders/(int: order)/boxes/¶ Create a new box.
Query Parameters: - bearer_token – The token for API access.
Parameters: - box – JSON data representing a new box to be created.
- order – ID of the order for which to create a box.
Status Codes: - 201 – New box was created.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/orders/1/boxes/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "order": "/api/v1/orders/1/", "charges": { "actual_ship_cost": "22.00 USD", "declared_value": "190.00 USD", "insured_value": "120.00 USD" }, "custom_fields": [ { "name": "Export", "value": "7" }, { "name": "Gift", "value": "8" } ], "delivery_confirmation": "signature_required", "general_description": "Red widget", "items": [ { "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "joint_production": true, "net_cost_begin_date": "2014-01-21 14:58:52", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23 14:58:52", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "scheduleb_commodity_code": "SCC-5", "charges": { "unit_price": "112.00 USD" }, "unit_weight": "20.0000", "url": "http://box.url" } ], "tracking_number": "TEST" }
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/orders/324235/ Content-Language: en-us
{ "charges": { "actual_ship_cost": "22.00 USD", "declared_value": "190.00 USD", "insured_value": "120.00 USD" }, "custom_fields": [ { "box": "/api/v1/boxes/3/", "created_at": "2014-10-08T12:20:05+00:00", "id": 5, "name": "Export", "resource_uri": "/api/v1/box_custom_fields/5/", "updated_at": "2014-10-08T12:20:05+00:00", "value": "7" }, { "box": "/api/v1/boxes/3/", "created_at": "2014-10-08T12:20:05+00:00", "id": 6, "name": "Gift", "resource_uri": "/api/v1/box_custom_fields/6/", "updated_at": "2014-10-08T12:20:05+00:00", "value": "8" } ], "delivery_confirmation": "signature_required", "general_description": "Red widget", "height": null, "items": [ { "box": "/api/v1/boxes/3/", "charges": { "unit_price": "112.00 USD" }, "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": null, "joint_production": true, "net_cost_begin_date": "2014-01-21T14:58:52+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23T14:58:52+00:00", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "resource_uri": "/api/v1/items/3/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "20.0000", "url": "http://box.url" } ], "length": null, "order": "/api/v1/orders/1/", "resource_uri": "/api/v1/boxes/3/", "saturday_delivery": null, "shipper_release": null, "tracking_number": "TEST", "weight": null, "width": null }
PUT¶
PUT works the same as the PATCH method in this API. See the documentation for PATCH method for more detail.
PATCH¶
-
PATCH/api/v1/boxes/(int: id)/¶ Update an existing box.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the box to update or create.
Status Codes: - 202 – Entry was updated.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry with provided id not found.
Example request:
curl -iL --request PATCH -H "Content-Type: application/json" --data '{"tracking_number": "New tracking number"}' "https://www.readycloud.com/api/v1/boxes/16/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "charges": { "actual_ship_cost": "124.00 USD", "declared_value": "88.00 USD", "insured_value": "104.00 USD" }, "custom_fields": [ { "box": "/api/v1/boxes/1/", "created_at": "2014-10-10T06:49:50+00:00", "id": 1, "name": "Check", "resource_uri": "/api/v1/box_custom_fields/1/", "updated_at": "2014-10-16T09:04:45+00:00", "value": "21" }, { "box": "/api/v1/boxes/1/", "created_at": "2014-10-10T06:49:50+00:00", "id": 2, "name": "Export", "resource_uri": "/api/v1/box_custom_fields/2/", "updated_at": "2014-10-16T09:04:45+00:00", "value": "22" } ], "delivery_confirmation": "signature_required", "general_description": "Green widget", "height": "10.0000", "items": [ { "box": "/api/v1/boxes/1/", "charges": { "unit_price": "157.00 USD" }, "commodity_code": "C-11", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": "11", "joint_production": true, "net_cost_begin_date": "2014-10-10T06:49:50+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2014-10-12T06:49:50+00:00", "origin_country_code": "US", "part_number": "PN-1", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "resource_uri": "/api/v1/items/1/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "157.0000", "url": "http://box.url" } ], "length": "10.0000", "order": "/api/v1/orders/1/", "resource_uri": "/api/v1/boxes/1/", "saturday_delivery": true, "shipper_release": true, "tracking_number": "New tracking number", "weight": "29.0000", "width": "10.0000" }
DELETE¶
-
DELETE/api/v1/boxes/(int: id)/¶ Delete a box.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Box not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/boxes/16/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us
Box Item Resource¶
GET¶
-
GET/api/v1/items/ or /api/v1/boxes/(int: box)/items/¶ Retrieve a list of box items.
All weight values are specified in grams. All length values are specified in meters.
Query Parameters: - bearer_token – The token for API access.
Parameters: - format – Expected format (JSON or XML).
- limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
- box – Box ID for which you want retrieve items.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/boxes/1/items/?format=json&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&order=1"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "box": "/api/v1/boxes/1/", "charges": { "unit_price": "15.00 USD" }, "commodity_code": "C-1", "description": "Item Description", "export_type_code": "SIM", "item_id": "1", "joint_production": true, "net_cost_begin_date": "2013-07-11T20:49:00+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2013-07-11T20:49:00+00:00", "origin_country_code": "US", "part_number": "PN-1", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "Yes", "quantity": 3, "resource_uri": "/api/v1/items/1/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "170.0000", "url": "http://box.url" } ] }
-
GET/api/v1/items/(int: id)/¶ Retrieve a single item by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the item to get.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/items/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 21:41:37 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Language: en-us Content-Type: application/json; charset=utf-8
{ "box": "/api/v1/boxes/1/", "charges": { "unit_price": "15.00 USD" }, "commodity_code": "C-1", "description": "Item Description", "export_type_code": "SIM", "item_id": "1", "joint_production": true, "net_cost_begin_date": "2013-07-11T20:49:00+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2013-07-11T20:49:00+00:00", "origin_country_code": "US", "part_number": "PN-1", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "Yes", "quantity": 3, "resource_uri": "/api/v1/items/1/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "170.0000", "url": "http://box.url" }
POST¶
-
POST/api/v1/items/ or /api/v1/boxes/(int: box)/items/¶ Create a new item.
Query Parameters: - bearer_token – The token for API access.
Parameters: - item – JSON data representing a new item to be created.
- box – The box for which to create a new item.
Status Codes: - 201 – New box was created.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/boxes/1/items/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "joint_production": true, "net_cost_begin_date": "2014-01-21 14:58:52", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23 14:58:52", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "scheduleb_commodity_code": "SCC-5", "charges": { "unit_price": "112.00 USD" }, "unit_weight": "20.0000", "url": "http://box.url" }
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/orders/324235/ Content-Language: en-us
{ "box": "/api/v1/boxes/1/", "charges": { "unit_price": "112.00 USD" }, "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": null, "joint_production": true, "net_cost_begin_date": "2014-01-21T14:58:52+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23T14:58:52+00:00", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "resource_uri": "/api/v1/items/2/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "20.0000", "url": "http://box.url" }
Example request:
curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/items/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "joint_production": true, "net_cost_begin_date": "2014-01-21 14:58:52", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23 14:58:52", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "scheduleb_commodity_code": "SCC-5", "box": "/api/v1/boxes/1/", "charges": { "unit_price": "112.00 USD" }, "unit_weight": "20.0000", "url": "http://box.url" }
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/orders/324235/ Content-Language: en-us
{ "box": "/api/v1/boxes/1/", "charges": { "unit_price": "112.00 USD" }, "commodity_code": "C-4", "description": "Unisex 'Some Chicks Marry Chicks'; White Size: Large", "export_type_code": "SIM", "item_id": null, "joint_production": true, "net_cost_begin_date": "2014-01-21T14:58:52+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2014-01-23T14:58:52+00:00", "origin_country_code": "USA", "part_number": "PN-3", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "No[2]", "quantity": 3, "resource_uri": "/api/v1/items/2/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "20.0000", "url": "http://box.url" }
PUT¶
PUT works the same as the PATCH method in this API. See the documentation for PATCH method for more detail.
PATCH¶
-
PATCH/api/v1/items/(int: id)/¶ Update an existing item.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the item to update or create.
Status Codes: - 202 – Entry was updated.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Item not found.
Example request:
curl -iL --request PATCH -H "Content-Type: application/json" --data '{"item_id": "New item id"}' "https://www.readycloud.com/api/v1/items/16/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "box": "/api/v1/boxes/1/", "charges": { "unit_price": "15.00 USD" }, "commodity_code": "C-1", "description": "Item Description", "export_type_code": "SIM", "item_id": "New item id", "joint_production": true, "net_cost_begin_date": "2013-07-11T20:49:00+00:00", "net_cost_code": "NCC", "net_cost_end_date": "2013-07-11T20:49:00+00:00", "origin_country_code": "US", "part_number": "PN-1", "pick_location": "Some location", "preference_criteria_code": "Criteria-5", "producer_info_code": "Yes", "quantity": 3, "resource_uri": "/api/v1/items/1/", "scheduleb_commodity_code": "SCC-5", "unit_weight": "170.0000", "url": "http://box.url" }
DELETE¶
-
DELETE/api/v1/items/(int: id)/¶ Delete an existing item.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Item not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/items/16/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us
Order Backup Details Resource¶
Order Backup Details group together orders which were backed up in a single batch operation.
GET¶
-
GET/api/v1/order_backup_details/¶ Retrieve a list of order backup details.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/order_backup_details/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:21:24 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 100, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "alias_id": "A-1", "backup": "/api/v1/xml_backup/1/", "id": 1, "numerical_id": 1, "primary_id": "1", "resource_uri": "/api/v1/order_backup_details/1/" } ] }
-
GET/api/v1/order_backup_details/(int: id)/¶ Retrieve a single order backup detail by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The ID of the entry to retrieve.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/order_backup_details/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:29:25 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "alias_id": "A-1", "backup": "/api/v1/xml_backup/1/", "id": 1, "numerical_id": 1, "primary_id": "1", "resource_uri": "/api/v1/order_backup_details/1/" }
Order Restore Resource¶
GET¶
-
GET/api/v1/order_restore/¶ Retrieve a set of orders for backup restoration.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/order_restore/?limit=2&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:21:24 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 100, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "actual_shipcost": "148.000", "actual_shipcost_currency_code": "USD", "alias_id": "A-1", "backup": "/api/v1/xml_backup/1/", "base_price": "74.000", "base_price_currency_code": "USD", "base_price_source": "imported", "calculated_base_price": "185.000", "calculated_base_price_currency_code": "USD", "calculated_shipping": "35.000", "calculated_shipping_currency_code": "USD", "calculated_tax": "161.000", "calculated_tax_currency_code": "USD", "calculated_total": "124.000", "calculated_total_currency_code": "USD", "created_at": "2013-07-11T20:49:00", "customer_number": "CN-1", "delivered_at": null, "future_ship_time": "2013-07-11T20:49:00", "id": 1, "import_time": "2013-07-11T20:49:00", "imported_base_price": "173.000", "imported_base_price_currency_code": "USD", "imported_shipping": "89.000", "imported_shipping_currency_code": "USD", "imported_tax": "137.000", "imported_tax_currency_code": "USD", "imported_total": "116.000", "imported_total_currency_code": "USD", "message": "Order message", "numerical_id": 1, "order_time": "2013-07-11T20:49:00", "po_number": "PO-1", "primary_id": "1", "print_time": "2013-07-11T20:49:00", "resource_uri": "/api/v1/order_restore/1/", "ship_time": "2013-07-11T20:49:00", "ship_type": "Default", "ship_via": "New Mail", "shipping": "196.000", "shipping_currency_code": "USD", "shipping_source": "imported", "source": "USPS", "status_shipped": true, "tax": "78.000", "tax_currency_code": "USD", "tax_source": "imported", "terms": "Order test terms", "total": "169.000", "total_currency_code": "USD", "total_source": "imported", "updated_at": "2013-07-11T20:49:00", "unique_id": "00002vBtLSBCD2yzMRJ301Z5", "warehouse": "test warehouse" } ], "xml": "<ordercollection xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"http://www.trueship.com/xml/TrueOrder1.10.xsd\"><order source=\"USPS\"><id><primary_id>1</primary_id><numerical_id>1</numerical_id><readycloud_id>1</readycloud_id><unique_id>00002vBtLSBCD2yzMRJ301Z5</unique_id><alias>A-1</alias></id><billing><base_price currency=\"USD\" source=\"imported\">74.000</base_price><imported_base_price currency=\"USD\">173.000</imported_base_price><calculated_base_price currency=\"USD\">185.000</calculated_base_price><shipping currency=\"USD\" source=\"imported\">196.000</shipping><imported_shipping currency=\"USD\">89.000</imported_shipping><calculated_shipping currency=\"USD\">35.000</calculated_shipping><tax currency=\"USD\" source=\"imported\">78.000</tax><imported_tax currency=\"USD\">137.000</imported_tax><calculated_tax currency=\"USD\">161.000</calculated_tax><total currency=\"USD\" source=\"imported\">169.000</total><imported_total currency=\"USD\">116.000</imported_total><calculated_total currency=\"USD\">124.000</calculated_total><address type=\"bill\"><company>FedEx</company><name_first>Nick</name_first><name_last>Smith</name_last><address1>2010 Warsaw Rd</address1><address2>Apt 4</address2><city>Roswell</city><state>NY</state><zip>56001</zip><country>United States</country><phone>6785851113</phone><email>[email protected]</email><residential_indicator enabled=\"false\" /><validated enabled=\"false\" /></address><po_number>PO-1</po_number></billing><time><order_time>1373575740</order_time><import_time>1373575740</import_time><ship_time>1373575740</ship_time><future_ship_time>1373575740</future_ship_time><print_time>1373575740</print_time></time><ship_data><ship_via>New Mail</ship_via><ship_type>Default</ship_type><address type=\"destination\"><company>FedEx</company><name_first>Nick</name_first><name_last>Smith</name_last><address1>2010 Warsaw Rd</address1><address2>Apt 4</address2><city>Roswell</city><state>NY</state><zip>56001</zip><country>United States</country><phone>6785851113</phone><email>[email protected]</email><residential_indicator enabled=\"false\" /><validated enabled=\"false\" /></address><box><tracking_number>EJ958083578US</tracking_number><container><length units=\"m\">2.0000</length><width units=\"m\">2.0000</width><height units=\"m\">1.0000</height></container><weight units=\"g\">118.0000</weight><actual_shipcost currency=\"USD\">9.000</actual_shipcost><cod><amount currency=\"USD\">10.000</amount><acceptable_payment_type><cash /></acceptable_payment_type></cod><shipper_release enabled=\"true\" /><saturday_delivery enabled=\"true\" /><declared_value currency=\"USD\">76.000</declared_value><insured_value currency=\"USD\">24.000</insured_value><general_description>Red widget</general_description><delivery_confirmation><signature_required /></delivery_confirmation><custom_fields><field name=\"Gift\">BCF</field></custom_fields><item><id>1</id><code>PN-1</code><description>Item Description</description><picklocation>Some location</picklocation><quantity>3</quantity><unit_price currency=\"USD\">15.000</unit_price><unit_weight units=\"g\">170.0000</unit_weight><url>http://box.url</url><origin_country_code>US</origin_country_code><joint_production>true</joint_production><commodity_code>C-1</commodity_code><netcost_code>NCC</netcost_code><netcost_begin_date>1373575740</netcost_begin_date><netcost_end_date>1373575740</netcost_end_date><producer_info_code>Yes</producer_info_code><preference_criteria_code>Criteria-5</preference_criteria_code><scheduleb_commodity_code>SCC-5</scheduleb_commodity_code><export_type_code>SIM</export_type_code><ups>ups123</ups><ean>ean123</ean><isbn>isbn123</isbn></item></box></ship_data><origin><address type=\"from\"><company>FedEx</company><name_first>Nick</name_first><name_last>Smith</name_last><address1>2010 Warsaw Rd</address1><address2>Apt 4</address2><city>Roswell</city><state>NY</state><zip>56001</zip><country>United States</country><phone>6785851113</phone><email>[email protected]</email><residential_indicator enabled=\"false\" /><validated enabled=\"false\" /></address></origin><message>Order message</message><status><shipped /></status><custom_fields><field name=\"Gift\">OCF</field></custom_fields><customer_number>CN-1</customer_number><actual_shipcost currency=\"USD\">148.000</actual_shipcost><terms>Order test terms</terms></order></ordercollection>" }
-
GET/api/v1/order_restore/(int: id)/¶ Retrieve a list of order restore resources.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The id of the entry to retrieve.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/order_restore/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:29:25 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "actual_shipcost": "148.000", "actual_shipcost_currency_code": "USD", "alias_id": "A-1", "backup": "/api/v1/xml_backup/1/", "base_price": "74.000", "base_price_currency_code": "USD", "base_price_source": "imported", "calculated_base_price": "185.000", "calculated_base_price_currency_code": "USD", "calculated_shipping": "35.000", "calculated_shipping_currency_code": "USD", "calculated_tax": "161.000", "calculated_tax_currency_code": "USD", "calculated_total": "124.000", "calculated_total_currency_code": "USD", "created_at": "2013-07-11T20:49:00", "customer_number": "CN-1", "delivered_at": null, "future_ship_time": "2013-07-11T20:49:00", "id": 1, "import_time": "2013-07-11T20:49:00", "imported_base_price": "173.000", "imported_base_price_currency_code": "USD", "imported_shipping": "89.000", "imported_shipping_currency_code": "USD", "imported_tax": "137.000", "imported_tax_currency_code": "USD", "imported_total": "116.000", "imported_total_currency_code": "USD", "message": "Order message", "numerical_id": 1, "order_time": "2013-07-11T20:49:00", "po_number": "PO-1", "primary_id": "1", "print_time": "2013-07-11T20:49:00", "resource_uri": "/api/v1/order_restore/1/", "ship_time": "2013-07-11T20:49:00", "ship_type": "Default", "ship_via": "New Mail", "shipping": "196.000", "shipping_currency_code": "USD", "shipping_source": "imported", "source": "USPS", "status_shipped": true, "tax": "78.000", "tax_currency_code": "USD", "tax_source": "imported", "terms": "Order test terms", "total": "169.000", "total_currency_code": "USD", "total_source": "imported", "updated_at": "2013-07-11T20:49:00", "unique_id": "00002vBtLSBCD2yzMRJ301Z5", "warehouse": "test warehouse" }
Order Restore Resource V2¶
GET¶
-
GET/api/v2/order_restore/¶ Retrieve a list of orders in TrueOrder XML format.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v2/order_restore/?limit=2&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:21:24 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/xml; charset=utf-8 Content-Language: en-us
<?xml version="1.0" encoding="UTF-8"?> <ordercollection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.trueship.com/xml/TrueOrder1.10.xsd"> <order source="USPS"> <id> <primary_id>1</primary_id> <numerical_id>1</numerical_id> <readycloud_id>1</readycloud_id> <unique_id>00002vBtLSBCD2yzMRJ301Z5</unique_id> <alias>A-1</alias> </id> <billing> <base_price currency="USD" source="imported">74.000</base_price> <imported_base_price currency="USD">173.000</imported_base_price> <calculated_base_price currency="USD">185.000</calculated_base_price> <shipping currency="USD" source="imported">196.000</shipping> <imported_shipping currency="USD">89.000</imported_shipping> <calculated_shipping currency="USD">35.000</calculated_shipping> <tax currency="USD" source="imported">78.000</tax> <imported_tax currency="USD">137.000</imported_tax> <calculated_tax currency="USD">161.000</calculated_tax> <total currency="USD" source="imported">169.000</total> <imported_total currency="USD">116.000</imported_total> <calculated_total currency="USD">124.000</calculated_total> <address type="bill"> <company>FedEx</company> <name_first>Nick</name_first> <name_last>Smith</name_last> <address1>2010 Warsaw Rd</address1> <address2>Apt 4</address2> <city>Roswell</city> <state>NY</state> <zip>56001</zip> <country>United States</country> <phone>6785851113</phone> <email>[email protected]</email> <residential_indicator enabled="false" /> <validated enabled="false" /> </address> <po_number>PO-1</po_number> </billing> <time> <order_time>1373575740</order_time> <import_time>1373575740</import_time> <ship_time>1373575740</ship_time> <future_ship_time>1373575740</future_ship_time> <print_time>1373575740</print_time> </time> <ship_data> <ship_via>New Mail</ship_via> <ship_type>Default</ship_type> <address type="destination"> <company>FedEx</company> <name_first>Nick</name_first> <name_last>Smith</name_last> <address1>2010 Warsaw Rd</address1> <address2>Apt 4</address2> <city>Roswell</city> <state>NY</state> <zip>56001</zip> <country>United States</country> <phone>6785851113</phone> <email>[email protected]</email> <residential_indicator enabled="false" /> <validated enabled="false" /> </address> <box> <tracking_number>EJ958083578US</tracking_number> <container> <length units="m">2.0000</length> <width units="m">2.0000</width> <height units="m">1.0000</height> </container> <weight units="g">118.0000</weight> <actual_shipcost currency="USD">9.000</actual_shipcost> <cod> <amount currency="USD">10.000</amount> <acceptable_payment_type> <cash /> </acceptable_payment_type> </cod> <shipper_release enabled="true" /> <saturday_delivery enabled="true" /> <declared_value currency="USD">76.000</declared_value> <insured_value currency="USD">24.000</insured_value> <general_description>Red widget</general_description> <delivery_confirmation> <signature_required /> </delivery_confirmation> <custom_fields> <field name="Gift">BCF</field> </custom_fields> <item> <id>1</id> <code>PN-1</code> <description>Item Description</description> <picklocation>Some location</picklocation> <quantity>3</quantity> <unit_price currency="USD">15.000</unit_price> <unit_weight units="g">170.0000</unit_weight> <url>http://box.url</url> <origin_country_code>US</origin_country_code> <joint_production>true</joint_production> <commodity_code>C-1</commodity_code> <netcost_code>NCC</netcost_code> <netcost_begin_date>1373575740</netcost_begin_date> <netcost_end_date>1373575740</netcost_end_date> <producer_info_code>Yes</producer_info_code> <preference_criteria_code>Criteria-5</preference_criteria_code> <scheduleb_commodity_code>SCC-5</scheduleb_commodity_code> <export_type_code>SIM</export_type_code> </item> </box> </ship_data> <origin> <address type="from"> <company>FedEx</company> <name_first>Nick</name_first> <name_last>Smith</name_last> <address1>2010 Warsaw Rd</address1> <address2>Apt 4</address2> <city>Roswell</city> <state>NY</state> <zip>56001</zip> <country>United States</country> <phone>6785851113</phone> <email>[email protected]</email> <residential_indicator enabled="false" /> <validated enabled="false" /> </address> </origin> <message>Order message</message> <status> <shipped /> </status> <custom_fields> <field name="Gift">OCF</field> </custom_fields> <customer_number>CN-1</customer_number> <actual_shipcost currency="USD">148.000</actual_shipcost> <terms>Order test terms</terms> </order> </ordercollection>
-
GET/api/v2/order_restore/(int: id)/¶ Retrieve an order in TrueOrder XML format.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The ID of the entry to retrieve.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Order not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v2/order_restore/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 08 Aug 2013 16:29:25 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/xml; charset=utf-8 Content-Language: en-us
<?xml version="1.0" encoding="UTF-8"?> <ordercollection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.trueship.com/xml/TrueOrder1.10.xsd"> <order source="USPS"> <id> <primary_id>1</primary_id> <numerical_id>1</numerical_id> <readycloud_id>1</readycloud_id> <unique_id>00002vBtLSBCD2yzMRJ301Z5</unique_id> <alias>A-1</alias> </id> <billing> <base_price currency="USD" source="imported">74.000</base_price> <imported_base_price currency="USD">173.000</imported_base_price> <calculated_base_price currency="USD">185.000</calculated_base_price> <shipping currency="USD" source="imported">196.000</shipping> <imported_shipping currency="USD">89.000</imported_shipping> <calculated_shipping currency="USD">35.000</calculated_shipping> <tax currency="USD" source="imported">78.000</tax> <imported_tax currency="USD">137.000</imported_tax> <calculated_tax currency="USD">161.000</calculated_tax> <total currency="USD" source="imported">169.000</total> <imported_total currency="USD">116.000</imported_total> <calculated_total currency="USD">124.000</calculated_total> <address type="bill"> <company>FedEx</company> <name_first>Nick</name_first> <name_last>Smith</name_last> <address1>2010 Warsaw Rd</address1> <address2>Apt 4</address2> <city>Roswell</city> <state>NY</state> <zip>56001</zip> <country>United States</country> <phone>6785851113</phone> <email>[email protected]</email> <residential_indicator enabled="false" /> <validated enabled="false" /> </address> <po_number>PO-1</po_number> </billing> <time> <order_time>1373575740</order_time> <import_time>1373575740</import_time> <ship_time>1373575740</ship_time> <future_ship_time>1373575740</future_ship_time> <print_time>1373575740</print_time> </time> <ship_data> <ship_via>New Mail</ship_via> <ship_type>Default</ship_type> <address type="destination"> <company>FedEx</company> <name_first>Nick</name_first> <name_last>Smith</name_last> <address1>2010 Warsaw Rd</address1> <address2>Apt 4</address2> <city>Roswell</city> <state>NY</state> <zip>56001</zip> <country>United States</country> <phone>6785851113</phone> <email>[email protected]</email> <residential_indicator enabled="false" /> <validated enabled="false" /> </address> <box> <tracking_number>EJ958083578US</tracking_number> <container> <length units="m">2.0000</length> <width units="m">2.0000</width> <height units="m">1.0000</height> </container> <weight units="g">118.0000</weight> <actual_shipcost currency="USD">9.000</actual_shipcost> <cod> <amount currency="USD">10.000</amount> <acceptable_payment_type> <cash /> </acceptable_payment_type> </cod> <shipper_release enabled="true" /> <saturday_delivery enabled="true" /> <declared_value currency="USD">76.000</declared_value> <insured_value currency="USD">24.000</insured_value> <general_description>Red widget</general_description> <delivery_confirmation> <signature_required /> </delivery_confirmation> <custom_fields> <field name="Gift">BCF</field> </custom_fields> <item> <id>1</id> <code>PN-1</code> <description>Item Description</description> <picklocation>Some location</picklocation> <quantity>3</quantity> <unit_price currency="USD">15.000</unit_price> <unit_weight units="g">170.0000</unit_weight> <url>http://box.url</url> <origin_country_code>US</origin_country_code> <joint_production>true</joint_production> <commodity_code>C-1</commodity_code> <netcost_code>NCC</netcost_code> <netcost_begin_date>1373575740</netcost_begin_date> <netcost_end_date>1373575740</netcost_end_date> <producer_info_code>Yes</producer_info_code> <preference_criteria_code>Criteria-5</preference_criteria_code> <scheduleb_commodity_code>SCC-5</scheduleb_commodity_code> <export_type_code>SIM</export_type_code> </item> </box> </ship_data> <origin> <address type="from"> <company>FedEx</company> <name_first>Nick</name_first> <name_last>Smith</name_last> <address1>2010 Warsaw Rd</address1> <address2>Apt 4</address2> <city>Roswell</city> <state>NY</state> <zip>56001</zip> <country>United States</country> <phone>6785851113</phone> <email>[email protected]</email> <residential_indicator enabled="false" /> <validated enabled="false" /> </address> </origin> <message>Order message</message> <status> <shipped /> </status> <custom_fields> <field name="Gift">OCF</field> </custom_fields> <customer_number>CN-1</customer_number> <actual_shipcost currency="USD">148.000</actual_shipcost> <terms>Order test terms</terms> </order> </ordercollection>
Order Revisions Resource¶
GET¶
-
GET/api/v1/orders/(int: order_id)/revisions/¶ Retrieve a list of order revisions.
This detail resource be expanded with additional inline data using the “expand” parameter. For example, to retrieve full details on items within the orders, ‘expand=boxes__items’ might be used. Available expansions are: boxes, boxes__items, all.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
- order_id – The order_id of the order you want to see revisions for.
- expand – Comma separated list of embedded resources to expand with full detail.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/orders/1/revisions/?limit=3&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "order": { "bill_to": { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/addresses/bill_to/" }, "boxes": [ { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/boxes/1/" } ], "charges": { "actual_shipcost": "148.00 USD", "calculated_grand_total": "124.00 USD", "calculated_shipping": "35.00 USD", "calculated_tax": "161.00 USD", "calculated_total": "185.00 USD", "grand_total": "169.00 USD", "grand_total_source": "imported", "imported_grand_total": "116.00 USD", "imported_shipping": "89.00 USD", "imported_tax": "137.00 USD", "imported_total": "173.00 USD", "shipping": "196.00 USD", "shipping_source": "imported", "tax": "78.00 USD", "tax_source": "imported", "total": "74.00 USD", "total_source": "imported" }, "created_at": true, "custom_fields": [ { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/custom_fields/1/" } ], "customer_number": "CN-1", "future_ship_time": "2013-07-11T20:49:00+00:00", "import_time": "2013-07-11T20:49:00+00:00", "message": "Order message", "numerical_id": 1, "order_time": "2013-07-11T20:49:00+00:00", "po_number": "PO-1", "primary_id": "1", "print_time": "2013-07-11T20:49:00+00:00", "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/", "ship_from": { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/addresses/ship_from/" }, "ship_time": "2013-07-11T20:49:00+00:00", "ship_to": { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/addresses/ship_to/" }, "ship_type": "Default", "ship_via": "New Mail", "source": "USPS", "status_shipped": true, "terms": "Order test terms", "updated_at": true, "warehouse": null, "unique_id": "1" }, "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/", "revision_date": "2013-07-11T20:49:00+00:00" } ] }
-
GET/api/v1/orders/(int: order_id)/revisions/(string: id)/¶ Retrieve a single order revision by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the order revision to get.
- order_id – ID of the order the revision belongs to.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Revision not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/?bearer_token=f843fa7f67287e600cd7de13992f380b"
Example response:
HTTP/1.0 200 OK Date: Fri, 09 Aug 2013 20:24:21 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: text/html; charset=utf-8 Content-Language: en-us
{ "order": { "bill_to": { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/addresses/bill_to/" }, "boxes": [ { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/boxes/1/" } ], "charges": { "actual_shipcost": "148.00 USD", "calculated_grand_total": "124.00 USD", "calculated_shipping": "35.00 USD", "calculated_tax": "161.00 USD", "calculated_total": "185.00 USD", "grand_total": "169.00 USD", "grand_total_source": "imported", "imported_grand_total": "116.00 USD", "imported_shipping": "89.00 USD", "imported_tax": "137.00 USD", "imported_total": "173.00 USD", "shipping": "196.00 USD", "shipping_source": "imported", "tax": "78.00 USD", "tax_source": "imported", "total": "74.00 USD", "total_source": "imported" }, "created_at": true, "custom_fields": [ { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/custom_fields/1/" } ], "customer_number": "CN-1", "future_ship_time": "2013-07-11T20:49:00+00:00", "import_time": "2013-07-11T20:49:00+00:00", "message": "Order message", "numerical_id": 1, "order_time": "2013-07-11T20:49:00+00:00", "po_number": "PO-1", "primary_id": "1", "print_time": "2013-07-11T20:49:00+00:00", "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/", "ship_from": { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/addresses/ship_from/" }, "ship_time": "2013-07-11T20:49:00+00:00", "ship_to": { "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/order/addresses/ship_to/" }, "ship_type": "Default", "ship_via": "New Mail", "source": "USPS", "status_shipped": true, "terms": "Order test terms", "updated_at": true, "warehouse": null, "unique_id": "1" }, "resource_uri": "/api/v1/orders/1/revisions/52f0ad135bcde7070e0b6693/", "revision_date": "2013-07-11T20:49:00+00:00" }
Remaining Orders Resource¶
GET¶
-
GET/api/v1/remaining_orders/(int: id)/¶ Retrieve the number of remaining orders for the company with the specified ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – The ID of the company to get the remaining orders number for.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Company not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/remaining_orders/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Fri, 02 Aug 2013 15:50:45 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "remaining_orders": 1991, "resource_uri": "/api/v1/remaining_orders/1/" }
-
GET/api/v1/remaining_orders/¶ Retrieve the number of remaining orders for the company with the specified ID as a param.
Query Parameters: - bearer_token – The token for API access.
- company_id – The id of the company to get the remaining orders number for.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Company not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/remaining_orders/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01&company_id=1"
Example response:
HTTP/1.0 200 OK Date: Fri, 02 Aug 2013 15:50:45 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "remaining_orders": 1991, "resource_uri": "/api/v1/remaining_orders/1/" }
-
GET/api/v1/remaining_orders/¶ Retrieve the number of remaining orders of your company, if you only have one.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 200 – Data successfully retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Company not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/remaining_orders/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Fri, 02 Aug 2013 15:50:45 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "remaining_orders": 1991, "resource_uri": "/api/v1/remaining_orders/" }
Account Resource¶
GET¶
-
GET/api/v1/accounts/¶ Retrieve a list of ReadyCloud accounts.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/accounts/?limit=3&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "avatar": "https://secure.gravatar.com/avatar/9e26471d35a78862c17e467d87cddedf?size=30", "email": "[email protected]", "first_name": "Jane", "id": 2, "last_name": "Doe", "name": "Jane Doe", "resource_uri": "/api/v1/accounts/2/" }
-
GET/api/v1/accounts/(int: id)/¶ Retrieve a single account by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the account to get.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/accounts/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 21:41:37 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Language: en-us Content-Type: application/json; charset=utf-8
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 2 }, "objects": [ { "avatar": "https://secure.gravatar.com/avatar/d4c74594d841139328695756648b6bd6?size=30", "email": "[email protected]", "first_name": "John", "id": 1, "last_name": "Example", "name": "John Example", "resource_uri": "/api/v1/accounts/1/" }, { "avatar": "https://secure.gravatar.com/avatar/9e26471d35a78862c17e467d87cddedf?size=30", "email": "[email protected]", "first_name": "Jane", "id": 2, "last_name": "Doe", "name": "Jane Doe", "resource_uri": "/api/v1/accounts/2/" } ] }
POST¶
-
POST/api/v1/accounts/¶ Create a new account.
Query Parameters: - bearer_token – The token for API access.
Parameters: - first_name – Account first name.
- last_name – Account last name.
- email – Account email.
- password – Account password.
- license_key – License key.
Status Codes: - 201 – New account was created.
- 400 – Bad request. See returned error message.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request POST -H "Content-Type: application/json" --data '{"first_name": "Test", "last_name": "User", "email": "[email protected]", "password": "password", "license_key": "VALID LICENSE KEY"}' "https://www.readycloud.com/api/v1/accounts/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/accounts/14/ Content-Language: en-us
{ "avatar": "https://secure.gravatar.com/avatar/b067256d3b007a1dcadb99df6033da59?size=30", "email": "[email protected]", "first_name": "Test", "id": 3, "last_name": "User", "name": "Test User", "resource_uri": "/api/v1/accounts/3/" }
PATCH¶
-
PATCH/api/v1/accounts/¶ Update account fields (only first_name and last_name can be changed).
Query Parameters: - bearer_token – The token for API access.
Parameters: - first_name – New account first name.
- last_name – New account last name.
Status Codes: - 202 – Account was updated.
- 400 – Bad request. See returned error message.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request PATCH -H "Content-Type: application/json" --data '{"first_name": "Test", "last_name": "User"}' "https://www.readycloud.com/api/v1/accounts/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/accounts/14/ Content-Language: en-us
{ "avatar": "https://secure.gravatar.com/avatar/d4c74594d841139328695756648b6bd6?size=30", "email": "[email protected]", "first_name": "Test", "id": 1, "last_name": "User", "name": "Test User", "resource_uri": "/api/v1/accounts/1/" }
PUT¶
Not implemented
DELETE¶
Not implemented
Packaging Resource¶
GET¶
-
GET/api/v1/packaging/¶ Retrieve a list of packaging definitions.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/packaging/?format=json&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "created_at": "2016-01-29T03:52:06+00:00", "description": "Generic small packaging", "height": "0.1500 m", "id": 1, "length": "0.2000 m", "name": "10x20x15", "package_type": "Cardboard Thick", "resource_uri": "/api/v1/packaging/1/", "revision": 1, "updated_at": "2016-01-29T03:52:06+00:00", "weight": "140.0000 g", "width": "0.1000 m" } ] }
-
GET/api/v1/packaging/(int: id)/¶ Retrieve a single packaging definition by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the packaging to get.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/packaging/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 21:41:37 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Language: en-us Content-Type: application/json; charset=utf-8
{ "created_at": "2016-01-29T03:52:06+00:00", "description": "Generic small packaging", "height": "0.1500 m", "id": 1, "length": "0.2000 m", "name": "10x20x15", "package_type": "Cardboard Thick", "resource_uri": "/api/v1/packaging/1/", "revision": 1, "updated_at": "2016-01-29T03:52:06+00:00", "weight": "140.0000 g", "width": "0.1000 m" }
POST¶
-
POST/api/v1/packaging/¶ Create a new packaging definition.
Query Parameters: - bearer_token – The token for API access.
Parameters: - packaging – JSON data representing the packaging to be created.
Status Codes: - 201 – New packaging was created.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v1/packaging/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
data.json:
{ "description": "Test Package Description", "height": "30.0000 m", "length": "10.0000 m", "name": "New packaging", "package_type": "Test packaging type", "weight": "100.0000 g", "width": "20.0000 m" }
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/packaging/2/ Content-Language: en-us
{ "created_at": "2014-10-07T13:58:45+00:00", "description": "Test Package Description", "height": "30.0000 m", "id": 2, "length": "10.0000 m", "name": "New packaging", "package_type": "Test packaging type", "resource_uri": "/api/v1/packaging/2/", "revision": 1, "updated_at": "2014-10-07T13:58:45+00:00", "weight": "100.0000 g", "width": "20.0000 m" }
PUT¶
PUT works the same as the PATCH method in this API. See the documentation for PATCH method for more detail.
PATCH¶
-
PATCH/api/v1/packaging/(int: id)/¶ Update an existing packaging definition.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the packaging to update.
Status Codes: - 202 – Entry was updated.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Packaging not found.
Example request:
curl -iL --request PATCH -H "Content-Type: application/json" --data '{"name": "Updated packaging name"}' "https://www.readycloud.com/api/v1/packaging/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "created_at": "2016-01-29T03:52:06+00:00", "description": "Generic small packaging", "height": "0.1500 m", "id": 1, "length": "0.2000 m", "name": "Updated packaging name", "package_type": "Cardboard Thick", "resource_uri": "/api/v1/packaging/1/", "revision": 2, "updated_at": "2016-01-29T03:52:06+00:00", "weight": "140.0000 g", "width": "0.1000 m" }
DELETE¶
-
DELETE/api/v1/packaging/(int: id)/¶ Delete an existing packaging definition.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Packaging not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/packaging/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us
Webhooks Resource¶
GET¶
-
GET/api/v1/webhooks/¶ Retrieve a list of registered webhooks.
Query Parameters: - bearer_token – The token for API access.
Parameters: - limit – The number of entries to limit the returned data to.
- offset – The entry to start the returned data with.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/webhooks/?format=json&bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 22:40:12 GMT Server: WSGIServer/0.1 Python/2.7.6 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1 }, "objects": [ { "created_at": "2014-10-10T08:46:23+00:00", "entity": "orders", "resource_uri": "/api/v1/webhooks/1/", "token": "27b83caceed276b14a83104f246a69", "updated_at": "2014-10-10T08:46:23+00:00", "url": "http://example.com/test" } ] }
-
GET/api/v1/webhooks/(int: id)/¶ Retrieve a single webhook by ID.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the webhook to get.
Status Codes: - 200 – Entry exists and was retrieved.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Entry not found.
Example request:
curl -iL --request GET "https://www.readycloud.com/api/v1/webhooks/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 200 OK Date: Thu, 01 Aug 2013 21:41:37 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Language: en-us Content-Type: application/json; charset=utf-8
{ "created_at": "2014-10-10T08:46:23+00:00", "entity": "orders", "resource_uri": "/api/v1/webhooks/1/", "token": "27b83caceed276b14a83104f246a69", "updated_at": "2014-10-10T08:46:23+00:00", "url": "http://example.com/test" }
POST¶
-
POST/api/v1/webhooks/¶ Register a new webhook.
Query Parameters: - bearer_token – The token for API access.
Parameters: - url – Your REST API endpoint to which webhook events should be posted. HTTPS is required.
- entity – Entity type for which to receive callbacks. Normally ‘orders’.
Status Codes: - 201 – New webhook was registered.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
Example request:
curl --dump-header - -H "Content-Type: application/json" -X POST -d '{"url": "https://example.com/test", "entity": "orders"}' https://www.readycloud.com/api/v1/webhooks/\?bearer_token\=7e9c40c638947e5762494d3003b6da38
Example response:
HTTP/1.0 201 CREATED Date: Thu, 01 Aug 2013 22:04:53 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Location: https://www.readycloud.com/api/v1/webhooks/2/ Content-Language: en-us
{ "created_at": "2014-10-07T14:57:10+00:00", "entity": "orders", "resource_uri": "/api/v1/webhooks/2/", "token": "4e003809bd4c85c542dc6afb374087", "updated_at": "2014-10-07T14:57:10+00:00", "url": "https://example.com/test" }
PUT¶
PUT works the same as the PATCH method in this API. See the documentation for PATCH method for more detail.
PATCH¶
-
PATCH/api/v1/webhooks/(int: id)/¶ Update an existing webhook.
Query Parameters: - bearer_token – The token for API access.
Parameters: - id – ID of the webhook to update.
Status Codes: - 202 – Entry was updated.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Webhook not found.
Example request:
curl -iL --request PATCH -H "Content-Type: application/json" --data '{"url": "https://localhost:5000/new"}' "https://www.readycloud.com/api/v1/webhooks/1/?bearer_token=7e9c40c638947e5762494d3003b6da38"
Example response:
HTTP/1.0 202 ACCEPTED Date: Thu, 01 Aug 2013 20:54:27 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Type: application/json; charset=utf-8 Content-Language: en-us
{ "created_at": "2014-10-07T14:58:37+00:00", "entity": "orders", "resource_uri": "/api/v1/webhooks/1/", "token": "27b83caceed276b14a83104f246a69", "updated_at": "2014-10-07T14:58:37+00:00", "url": "https://localhost:5000/new" }
DELETE¶
-
DELETE/api/v1/webhooks/(int: id)/¶ Delete an existing webhook.
Query Parameters: - bearer_token – The token for API access.
Status Codes: - 204 – Entry was deleted.
- 401 – Invalid bearer token.
- 403 – Token doesn’t have access to the resource.
- 404 – Webhook not found.
Example request:
curl -iL --request DELETE "https://www.readycloud.com/api/v1/webhooks/2/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"
Example response:
HTTP/1.0 204 NO CONTENT Date: Thu, 01 Aug 2013 20:44:07 GMT Server: WSGIServer/0.1 Python/2.7.4 Vary: Accept-Language, Cookie Content-Length: 0 Content-Type: text/html; charset=utf-8 Content-Language: en-us