InventoryLocationResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InventoryLocationResponse",
  "title": "InventoryLocationResponse",
  "type": "object",
  "properties": {
    "location": {
      "description": "This container provides location details of an inventory location. The <strong>address</strong> container will always be returned, but it will not always have a complete street address. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location. The <strong>geoCoordinates</strong> container will only be returned if the merchant provided geographical coordinates. The <strong>locationId</strong> field is always returned, but this value is only used internally by eBay.",
      "$ref": "#/components/schemas/Location"
    },
    "locationAdditionalInformation": {
      "type": "string",
      "description": "This text field provides additional information about an inventory location. This field is returned if it is set for the inventory location. <br><br><b>Max length</b>: 256"
    },
    "locationInstructions": {
      "type": "string",
      "description": "This text field is used by the merchant to provide special pickup instructions for the store location. This field can help create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field was not set up through a <strong>createInventoryLocation</strong> or a <strong>updateInventoryLocation</strong> call, eBay will use the default pickup instructions contained in the merchant's profile.<br><br><b>Max length</b>: 1000"
    },
    "locationTypes": {
      "type": "array",
      "description": "This container defines the function of the inventory location. Typically, an inventory location will serve as a store or a warehouse, but in some cases, an inventory location may be both.<br><br>For In-Store Pickup inventory set <b>StoreTypeEnum</b> to <code>STORE</code>.<br><br>The location type of an inventory location defaults to <code>WAREHOUSE</code> if a location type is not specified when a merchant creates an inventory location.",
      "items": {
        "type": "string",
        "description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/api:StoreTypeEnum'>eBay API documentation</a>"
      }
    },
    "locationWebUrl": {
      "type": "string",
      "description": "This text field shows the  Website address (URL) associated with the inventory location. This field is returned if defined for the inventory location. <br><br><b>Max length</b>: 512"
    },
    "merchantLocationKey": {
      "type": "string",
      "description": "The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the <strong>createInventoryLocation</strong> call. Once this value is set for an inventory location, it cannot be modified.<br><br><b>Max length</b>: 36"
    },
    "merchantLocationStatus": {
      "type": "string",
      "description": "This field indicates whether the inventory location is enabled (inventory can be loaded to location) or disabled (inventory can not be loaded to location). The merchant can use the <strong>enableInventoryLocation</strong> call to enable an inventory location in disabled status, or the <strong>disableInventoryLocation</strong> call to disable an inventory location in enabled status. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/api:StatusEnum'>eBay API documentation</a>"
    },
    "name": {
      "type": "string",
      "description": "The name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. For store inventory locations, this field is not required for the <strong>createInventoryLocation</strong> call, but a store inventory location must have a defined <strong>name</strong> value before an In-Store Pickup and Click and Collect enabled offer is published. So, if the seller omits this field in the <strong>createInventoryLocation</strong> call, it will have to be added later through a <strong>updateInventoryLocation</strong> call.<br><br><b>Max length</b>: 1000"
    },
    "operatingHours": {
      "type": "array",
      "description": "This container shows the regular operating hours for a store location during the days of the week. A <strong>dayOfWeekEnum</strong> field and an <strong>intervals</strong> container is shown for each day of the week that the store location is open.",
      "items": {
        "$ref": "#/components/schemas/OperatingHours"
      }
    },
    "phone": {
      "type": "string",
      "description": "The phone number for an inventory location. This field will typically only be set and returned for store locations.<br><br><b>Max length</b>: 36"
    },
    "specialHours": {
      "type": "array",
      "description": "This container shows the special operating hours for a store location on a specific date or dates.",
      "items": {
        "$ref": "#/components/schemas/SpecialHours"
      }
    }
  },
  "description": "This type is used by the base response of the <strong>getInventoryLocation</strong> and <strong>getInventoryLocations</strong> calls. These responses provide details about inventory location(s) defined for the merchant's account."
}