{ "opencollection": "1.0.0", "info": { "name": "IO.Common Accounts Locations API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Locations", "type": "folder" }, "items": [ { "info": { "name": "Get all locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations", "params": [ { "name": "Type", "value": "", "type": "query" }, { "name": "WithProperties", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all locations" }, { "info": { "name": "Create a new locations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Locations", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new locations" }, { "info": { "name": "Get service locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:serviceId", "params": [ { "name": "serviceId", "value": "", "type": "path" }, { "name": "Type", "value": "", "type": "query" }, { "name": "WithProperties", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get service locations" }, { "info": { "name": "Get location details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get location details" }, { "info": { "name": "Update location details", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Locations/:locationId", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location id to be updated" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update location details" }, { "info": { "name": "Delete location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Locations/:locationId", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location id to be deleted" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete location" }, { "info": { "name": "Get order notification settings for location (buyer side)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/order-notifications", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get order notification settings for location (buyer side)" }, { "info": { "name": "Update order notification settings for location (buyer side)", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Locations/:locationId/order-notifications", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update order notification settings for location (buyer side)" }, { "info": { "name": "Get order notification settings for a vendor account at this location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/accounts/:accountId/order-notifications", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "accountId", "value": "", "type": "path", "description": "Vendor Account Id" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get order notification settings for a vendor account at this location" }, { "info": { "name": "Update order notification settings for a vendor account at this location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Locations/:locationId/accounts/:accountId/order-notifications", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "accountId", "value": "", "type": "path", "description": "Vendor Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update order notification settings for a vendor account at this location" }, { "info": { "name": "Get all vendor accounts for a location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/vendors", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all vendor accounts for a location" }, { "info": { "name": "Add a vendor account to the location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Locations/:locationId/vendors", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add a vendor account to the location" }, { "info": { "name": "Update vendor order notification settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Locations/:locationId/vendors/:accountIdToUpdate", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "accountIdToUpdate", "value": "", "type": "path", "description": "Vendor to update" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update vendor order notification settings" }, { "info": { "name": "Remove vendor account from location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Locations/:locationId/vendors/:accountIdToRemove", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "accountIdToRemove", "value": "", "type": "path", "description": "Account id to be removed" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove vendor account from location" }, { "info": { "name": "Get all customer accounts for a location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/customers", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all customer accounts for a location" }, { "info": { "name": "Upsert customer accounts for a location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Locations/:locationId/customers", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upsert customer accounts for a location" }, { "info": { "name": "Get location groups related to current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/groups", "params": [ { "name": "locationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get location groups related to current user" }, { "info": { "name": "Returns all devices linked to the location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/devices", "params": [ { "name": "locationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all devices linked to the location" }, { "info": { "name": "Link location and device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Locations/:locationId/devices", "params": [ { "name": "locationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Link location and device" }, { "info": { "name": "Unlink device to the location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Locations/:locationId/devices/:deviceId", "params": [ { "name": "locationId", "value": "", "type": "path" }, { "name": "deviceId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unlink device to the location" }, { "info": { "name": "Returns all area locks in the location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/locks", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all area locks in the location" }, { "info": { "name": "Returns all area locks for the given area in the location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/locks/:wmsAreaId", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location id" }, { "name": "wmsAreaId", "value": "", "type": "path", "description": "Area id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all area locks for the given area in the location" }, { "info": { "name": "Save all area locks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Locations/:locationId/locks/:wmsAreaId", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location id" }, { "name": "wmsAreaId", "value": "", "type": "path", "description": "Area id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Save all area locks" }, { "info": { "name": "Get the list of all the properties added to locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/properties", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the list of all the properties added to locations" }, { "info": { "name": "Get the defined properties for locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/definedProperties", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the defined properties for locations" }, { "info": { "name": "Create new location property with parameters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Locations/definedProperties", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create new location property with parameters" }, { "info": { "name": "Update existing location property with parameters", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Locations/definedProperties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Property parameter Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update existing location property with parameters" }, { "info": { "name": "Delete existing location property with parameters", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Locations/definedProperties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Property parameter Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete existing location property with parameters" }, { "info": { "name": "Bulk upsert/delete location properties with parameters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Locations/definedProperties/bulk", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk upsert/delete location properties with parameters" }, { "info": { "name": "Get the list of all external tenants related to this location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/:locationId/tenants", "params": [ { "name": "locationId", "value": "", "type": "path", "description": "Location id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the list of all external tenants related to this location" }, { "info": { "name": "Get company locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Locations/forCompany", "params": [ { "name": "Type", "value": "", "type": "query" }, { "name": "WithProperties", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get company locations" } ] } ], "bundled": true }