swagger: '2.0'
info:
description: "\n\n## Overview\n\n\n\nThis application offers an API for managing assignments and tasks.\n\n\n\nGraphQL endpoint for the same API is [also available](/graph)\n\n\n\n<details><summary>Authentication</summary>\n\n\n\n> \n\n> Authenticate using your Erply credentials and get a sessionKey. This sessionKey and your Erply clientCode must be provided in the HTTP headers of every request. You do not have to authenticate against this API - valid Erply sessionKey-s from other sources are also acceptable. To authenticate using this API, use the `POST /api/v1/auth` endpoint.\n\n>\n\n</details>\n\n"
title: assignments Assortment Locations in warehouse API
contact: {}
version: 2.36.5
host: ''
basePath: ''
schemes: []
tags:
- name: Locations in warehouse
paths:
/v1/warehouse/locations:
get:
security:
- sk: []
- cc: []
- jwt: []
description: API client specifies record ID or multiple IDs and fetches attributes for all those records.
consumes:
- application/json
produces:
- application/json
tags:
- Locations in warehouse
summary: Read Locations in warehouse
parameters:
- type: integer
description: skip n records
name: skip
in: query
- type: integer
description: amount to take
name: take
in: query
- type: string
description: the sort parameter is explained in the `Filtering & Sorting` section on top of the Swagger documentation
name: sort
in: query
- type: string
description: the filter parameter is explained in the `Filtering & Sorting` section on top of the Swagger documentation
name: filter
in: query
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/warehouses.LocationJSON'
'400':
description: Bad Request
schema:
$ref: '#/definitions/responses.MessageResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/responses.MessageResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/responses.MessageResponse'
definitions:
responses.MessageResponse:
type: object
properties:
message:
type: string
example: some message
warehouses.LocationJSON:
type: object
properties:
added:
description: Unix timestamp
type: integer
example: 1595230999
addedby:
description: username
type: string
example: k@erp.xyz
changed:
description: Unix timestamp
type: integer
example: 1595230999
changedby:
description: username
type: string
example: k@erp.xyz
id:
description: object ID
type: integer
example: 1234
name:
type: string
example: loc1
securityDefinitions:
AccessToken:
type: apiKey
name: accessToken
in: header
ErplyClientCode:
type: apiKey
name: clientCode
in: header
ErplyJWT:
type: apiKey
name: jwt
in: header
ErplySession:
type: apiKey
name: sessionKey
in: header
RequestKey:
type: apiKey
name: requestKey
in: header