{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Location API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Location", "type": "folder" }, "items": [ { "info": { "name": "getInventoryLocation", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/location/:merchantLocationKey", "params": [ { "name": "merchantLocationKey", "value": "", "type": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is being retrieved.

Use the getInventoryLocations method to retrieve merchant location keys.

Max length: 36" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This call retrieves all defined details of the inventory location that is specified by the merchantLocationKey path parameter.

The authorization HTTP header is the only required request header for this call.

A successful call will return an HTTP status value of 200 OK.

" }, { "info": { "name": "createInventoryLocation", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/location/:merchantLocationKey", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "merchantLocationKey", "value": "", "type": "path", "description": "This path parameter specifies the unique, seller-defined key (ID) for an inventory location.

Max length: 36" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

Use this call to create a new inventory location. In order to create and publish an offer (and create an eBay listing), a seller must have at least one inventory location, as every offer must be associated with a location.

Upon first creating an inventory location, only a seller-defined location identifier and a physical location is required, and once set, these values can not be changed. The unique identifier value (merchantLocationKey) is passed in at the end of the call URI. T" }, { "info": { "name": "deleteInventoryLocation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ebay.com{basePath}/location/:merchantLocationKey", "params": [ { "name": "merchantLocationKey", "value": "", "type": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for the inventory location that is to be deleted.

Use the getInventoryLocations method to retrieve merchant location keys.

Max length: 36" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

This call deletes the inventory location that is specified in the merchantLocationKey path parameter. Note that deleting a location will not affect any active eBay listings associated with the deleted location, but the seller will not be able modify the offers associated with the inventory location once it is deleted.

The authorization HTTP header is the only required request header for this call.

Unless one or more errors and/or warnings occur with the " }, { "info": { "name": "disableInventoryLocation", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/location/:merchantLocationKey/disable", "params": [ { "name": "merchantLocationKey", "value": "", "type": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is to be disabled.

Use the getInventoryLocations method to retrieve merchant location keys.

Max length: 36" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

This call disables the inventory location that is specified in the merchantLocationKey path parameter. Sellers can not load/modify inventory to disabled inventory locations. Note that disabling an inventory location will not affect any active eBay listings associated with the disabled location, but the seller will not be able modify the offers associated with a disabled inventory location.

A successful call will return an HTTP status value of 200 OK.

" }, { "info": { "name": "enableInventoryLocation", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/location/:merchantLocationKey/enable", "params": [ { "name": "merchantLocationKey", "value": "", "type": "path", "description": "This path parameter specifies unique merchant-defined key (ID) for a disabled inventory location that is to be enabled.

Use the getInventoryLocations method to retrieve merchant location keys.

Max length: 36" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

This call enables a disabled inventory location that is specified in the merchantLocationKey path parameter. Once a disabled inventory location is enabled, sellers can start loading/modifying inventory to that inventory location.

A successful call will return an HTTP status value of 200 OK.

" }, { "info": { "name": "getInventoryLocations", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/location", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be a positive integer value. If this query parameter is not set, up to 100 records will be returned on each page of results.

Min: 1" }, { "name": "offset", "value": "", "type": "query", "description": "Specifies the number of locations to skip in the result set before returning the first location in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This call retrieves all defined details for every inventory location associated with the seller's account. There are no required parameters for this call and no request payload. However, there are two optional query parameters, limit and offset. The limit query parameter sets the maximum number of inventory locations returned on one page of data, and the offset query parameter specifies the page of data to return. These query pa" }, { "info": { "name": "updateInventoryLocation", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/location/:merchantLocationKey/update_location_details", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "merchantLocationKey", "value": "", "type": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is to be updated.

Use the getInventoryLocations method to retrieve merchant location keys.

Max length: 36" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

Use this call to update non-physical location details for an existing inventory location. Specify the inventory location you want to update using the merchantLocationKey path parameter.

You can update the following text-based fields: name, phone, locationWebUrl, locationInstructions and locationAdditionalInformation. Whatever text is passed in for these fields in an updateInventoryLocat" } ] } ], "bundled": true }