<< 51Assign groups of customers to promotion Lists

(Quick Reference)

52 Warehouses - Reference Documentation

Version: 2.1

52.1List

52.2Show

52.3Create

52.4Update

52.5Upsert

52.6Delete

52 Warehouses

52.1 List

Service: list warehouses

Description: This web service returns a json list of warehouses.

URL:

https://BASE_URL/api/VERSION/warehouses

Method: GET

Parameters:

Pagination parameters:

Name	Description	Type	Required	Possible values
max	Limits the number of resources requested to return.	Integer	no
offset	Tells where to start returning records from the entire set of results.	Integer	no
order	Orders ascending or descending.	Integer	no	asc,desc
sort	Orders the results by the specified field.	String	no

The max parameter is set to 100 by default.

Filters parameters:

Name	Description	Type	Required	Example values
dateCreated_gt	Filters by the resource's creation date time and operator greater than	Date	no	2016-08-15T14:52:48Z
dateCreated_gte	Filters by the resource's creation date time and operator greater than or equal	Date	no
dateCreated_lt	Filters by the resource's creation date time and operator less than	Date	no
dateCreated_lte	Filters by the resource's creation date time and operator less than or equal	Date	no
lastUpdated_gt	Filters by the resource's last-modified date time and operator greater than	Date	no
lastUpdated_gte	Filters by the resource's last-modified date time and operator greater than or equal	Date	no
lastUpdated_lt	Filters by the resource's last-modified date time and operator less than	Date	no
lastUpdated_lte	Filters by the resource's last-modified date time and operator less than or equal	Date	no
reference	Wildcard search by the resource's reference	String	no	reference=Ref-6* , reference=ef-6 , reference=ef-6*
name	Wildcard search by the resource's name	String	no

Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Status: HTTP/1.1 200 OK

{
  "paging": {
    "total": 18,
    "max": 5,
    "offset": 0,
    "previous": null,
    "next": "/api/v1.0/warehouses?max=5&offset=5&sort=dateCreated&order=asc"
  },
  "data": [
    {
      "id": 4,
      "name": "entrepot1",
      "reference": "entrepot1",
      "organization": "entity1",
      "isRoot": false,
      "parentReference": "wh-01",
      "parentWhse": {
        "id": 2,
        "reference": "wh-01",
        "name": "Main warehouse",
        "href": "/api/v1.0/warehouses/2"
      },
      "description": "entrepot1",
      "address": "entrepot1",
      "isVan": false,
      "users": [
        {
          "id": 4,
          "reference": "emp-00",
          "href": "/api/v1.0/users/4"
        },
        {
          "id": 5,
          "reference": "emp-03",
          "href": "/api/v1.0/users/5"
        }
      ],
      "dateCreated": "2015-12-15T16:58:46Z",
      "lastUpdated": "2016-05-04T14:48:26Z"
    },…
  ]
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "invalid_param",
  "error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}

52.2 Show

Service: Show a warehouse

Description: Returns the requested warehouse in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/warehouses/{id}

URL with external_id:

https://BASE_URL/api/VERSION/warehouses/reference/{id}

Method: GET

Parameters:

Name	Description	Type	Required	Example values
id	The unique ID of the desired warehouse	Long/String	yes	123

Success Output

Status: HTTP/1.1 200 OK

{
  "id": 4,
  "name": "entrepot1",
  "reference": "entrepot1",
  "organization": "entity1",
  "isRoot": false,
  "parentReference": "wh-01",
  "parentWhse": {
    "id": 2,
    "reference": "wh-01",
    "name": "Main warehouse",
    "href": "/api/v1.0/warehouses/2"
  },
  "description": "entrepot1",
  "address": "entrepot1",
  "isVan": false,
  "users": [
    {
      "id": 4,
      "reference": "emp-00",
      "href": "/api/v1.0/users/4"
    },
    {
      "id": 5,
      "reference": "emp-03",
      "href": "/api/v1.0/users/5"
    }
  ],
  "dateCreated": "2015-12-15T16:58:46Z",
  "lastUpdated": "2016-05-04T14:48:26Z"
}

Failure Output

Status: HTTP/1.1 404 Not Found

{
  "error": "not_found",
  "error_description": "The warehouse with the id 100 doesn't exist."
}

Status: HTTP/1.1 400 Bad Request

{
  "error": "invalid_param_type",
  "error_description": "The type of parameter id you provided is not valid for this request."
}

52.3 Create

Service: Create a warehouse

Description: Returns the created warehouse in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/warehouses

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
reference		String	yes
name		String	yes
isVan	By default, it is set to false	Boolean	no	true, false
parentId	Required if isVan equal to true	Long/String	-
description		String	no
address		String	no
users	Required if isVan equal to false	List	-	[18,19]
userId	Required if isVan equal to true	Long/String	-	21
useExternalId	By default, it is set to false. set it to true if you want to use external ids.	Boolean	no	true , false

reference must be unique

Success Output

Status: HTTP/1.1 201 Created

{
  "id": 3,
  "name": " john van",
  "reference": "van_17",
  "isRoot": false,
  "parentReference": "wh-01",
  "parentWhse": {
    "id": 2,
    "reference": "wh-01",
    "name": "Main warehouse",
    "href": "/api/v1.0/warehouses/2"
  },
  "description": null,
  "address": null,
  "isVan": true,
  "users": [
    {
      "id": 21,
      "reference": "emp_21",
      "href": "/api/v1.0/users/21"
    }
  ],
  "organization": "entity1",
  "dateCreated": "2015-12-15T16:58:03Z",
  "lastUpdated": "2015-12-15T16:58:03Z"
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "missing_param",
  "error_description": "name parameter is missing"
}

Status: HTTP/1.1 404 Not Found

{
  "error": "already_assigned",
  "error_description": "The user with the id 19 is already assigned to another warehouse/van."
}

{
  "error": "not_found",
  "error_description": "The parent warehouse with the id 255 doesn't exist."
}

52.4 Update

Service: Save a warehouse

Description: This web service is used to update an existing warehouse instance.

URL:

https://BASE_URL/api/VERSION/warehouses

URL with external_id:

https://BASE_URL/api/VERSION/warehouses/reference/{id}

Method: PUT

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
id	The ID of the desired warehouse	Long	yes	123
reference		String	yes
name		String	yes
isVan	By default, it is set to false	Boolean	no	true, false
parentId	Required if isVan equal to true	Long/String	-
description		String	no
address		String	no
users	Required if isVan equal to false	List	-	[18,19]
userId	Required if isVan equal to true	Long/String	-	21

reference must be unique

Success Output

Success case: response.status=201

{
  "id": 3,
  "name": " john van",
  "reference": "van_17",
  "isRoot": false,
  "parentReference": "wh-01",
  "parentWhse": {
    "id": 2,
    "reference": "wh-01",
    "name": "Main warehouse",
    "href": "/api/v1.0/warehouses/2"
  },
  "description": null,
  "address": null,
  "isVan": true,
  "users": [
    {
      "id": 21,
      "reference": "emp_21",
      "href": "/api/v1.0/users/21"
    }
  ],
  "organization": "entity1",
  "dateCreated": "2015-12-15T16:58:03Z",
  "lastUpdated": "2016-08-23T16:23:15Z"
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "missing_param",
  "error_description": "name parameter is missing"
}

Status: HTTP/1.1 404 Not Found

{
  "error": "already_assigned",
  "error_description": "The user with the id 19 is already assigned to another warehouse/van."
}

{
  "error": "not_found",
  "error_description": "The parent warehouse with the id 255 doesn't exist."
}

52.5 Upsert

Service: Upsert a warehouse

Description: This web service is used to insert a warehouse object to the database if it does not already exist, or update it.

URL with external_id:

https://BASE_URL/api/VERSION/warehouses/reference/{id}

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
name		String	yes
isVan	By default, it is set to false	Boolean	no	true, false
parentId	Required if isVan equal to true	Integer/String	-
description		String	no
address		String	no
users	Required if isVan equal to false	List	-	[18,19]
userId	Required if isVan equal to true	Integer/String	-	21

reference must be unique

Success Output

Status: HTTP/1.1 201 Created

{
  "id": 3,
  "name": " john van",
  "reference": "van_17",
  "isRoot": false,
  "parentReference": "wh-01",
  "parentWhse": {
    "id": 2,
    "reference": "wh-01",
    "name": "Main warehouse",
    "href": "/api/v1.0/warehouses/2"
  },
  "description": null,
  "address": null,
  "isVan": true,
  "users": [
    {
      "id": 21,
      "reference": "emp_21",
      "href": "/api/v1.0/users/21"
    }
  ],
  "organization": "entity1",
  "dateCreated": "2015-12-15T16:58:03Z",
  "lastUpdated": "2015-12-15T16:58:03Z"
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "missing_param",
  "error_description": "name parameter is missing"
}

Status: HTTP/1.1 404 Not Found

{
  "error": "already_assigned",
  "error_description": "The user with the id 19 is already assigned to another warehouse/van."
}

{
  "error": "not_found",
  "error_description": "The parent warehouse with the id 255 doesn't exist."
}

52.6 Delete

Service: Delete a warehouse

Description: This web service is used in order to delete an existing warehouse instance.

URL:

https://BASE_URL/api/VERSION/warehouses/{id}

URL with external_id:

https://BASE_URL/api/VERSION/warehouses/reference/{id}

Method: DELETE

Parameters:

Name	Description	Type	Required	Examples values
id	The ID of the desired warehouse	Long/String	Yes	123

Success Output

Success case: response.status=200

{
    "success": "true",
    "success_description": "Instance deleted successfully"
}

Failure Output

Failure case:response.status = 404

{
    "error": "not_found",
    "error_description": "The warehouse with the id 123 doesn't exist."
}

Failure case:response.status = 400

{
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}

{
    "error": "delete_failed",
    "error_description": "Failed to delete instance"
}

{
  "error": "delete_not_authorized",
  "error_description": "Main warehouse must not be deleted"
}

Failure case:response.status = 500

{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}

<< 51Assign groups of customers to promotion Lists

53Warehouse stocks >>

52 Warehouses - Reference Documentation

Table of Contents

52 Warehouses

52.1 List

Success Output

Failure Output

52.2 Show

Success Output

Failure Output

52.3 Create

Success Output

Failure Output

52.4 Update

Success Output

Failure Output

52.5 Upsert

Success Output

Failure Output

52.6 Delete

Success Output

Failure Output

Answers

Appointment

Appointment Categories

Attribute values

Attributes

Authentication

Authority

Check In List

Contacts

Customer Categories

Customer Categories Discount Lists

Customer Categories Price Lists

Customer Categories Tax Lists

Customer Discounts

Customer Employee

Customer Group Promotion Lists

Customer Groups

Customer Groups Assign

Customer Price List

Customer Promo List

Customer Segmentations

Customer Tax List

Customers

Deliveries

Discount lists

Employee Groups

Employee Item Category Assign

Employee WareHouses

Employees

Exchange rates

Item Categories

Item Groups

Item Groups Assign

Item attributes

Item category translation

Item customer groups assign

Item group translation

Item translation

Item units

Items

Loading details

Loadings

Objectives

Operation Prepayments

Operation lines

Operation payments

Operations

Payment types

Prepayment Allocations

Price List

Prices

Promotion inputs

Promotion outputs

Promotions

Question Columns

Question Lines

Question options

Questions

Reasons