Orders Resources

Monday, 23 of February 2015

Introduction

The purpose of this section is to describe the Repcamp's order Resources. Each resource is described through a list fields definition guide and their uses in the Resources request / response actions

 

GET orders

Receive a collection of order Objects.

 

Resource URL

http://api.repcamp.com/v1/orders

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: GET
Resource family: orders
Response Object: order
API Version: v1.1

 

Parameters

Parameter Required? Description
skip No Number of objects to be get by the request. Required for a paginated request
https://api.repcamp.com/v1/orders?skip=200&take=20
take No Number of objects to be get by the request. Required for a paginated request
https://api.repcamp.com/v1/orders?skip=200&take=20

Response

Status 200  - Content body: Array of orders

Status: 401 - Unauthorized

Status: 500 - Error

 

POST /orders/status/bulk

Change the status of a given array of orders .

 

Resource URL

http://api.repcamp.com/v1/orders/status/bulk

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: POST
Resource family: orders
Post Object: array of [{order_code,stattus}]
API Version: v1.1

Response

Status 200  - Content body: JSON Object
 

{Total:Elements sended
updates: Number of updates
errors: Number of errors
items_error: array that contains the codes of the error objects. }

 

{
"item_type": "order",
"total": 2,
"updates": 0,
"errors": 0,
"items_error": [ ]
}

 

Status: 401 - Unauthorized

Status: 500 - Error

 

Order Status Code-Reference

  • -1Canceled
  • 2Pending
  • 3In Process
  • 4Error
  • 5Delivered
  • 6Completed