SHshipengine
warehouses

Get Warehouse By Id

Changed on

Retrieve warehouse data based on the warehouse ID

get/v1/warehouses/{warehouse_id}

Request

  • Base URL
    https://api.shipengine.com
  • URL
    https://api.shipengine.com/v1/warehouses/{warehouse_id}
  • Auth
    API key in header API-Key

Response

The request was a success.

warehouse_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

is_defaultboolean nullable

Designates which single warehouse is the default on the account

namestring

Name of the warehouse

created_atstring date-time

Timestamp that indicates when the warehouse was created

Example response

{
  "warehouse_id": "se-28529731",
  "name": "Zero Cool HQ",
  "created_at": "2019-06-25T18:12:35.583Z",
  "origin_address": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA"
  },
  "return_address": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA"
  }
}

Changes

  • e4ae9b442f54Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 5a15ef11fd60Revision changes
    • warning

      added the new file_not_found enum value to the //// response property for the response status

    • warning

      added the new file_not_found enum value to the //// response property for the response status

    • warning

      added the new file_not_found enum value to the //// response property for the response status

    • warning

      added the new funding_source_error enum value to the //// response property for the response status

    • warning

      added the new funding_source_error enum value to the //// response property for the response status

    • warning

      added the new funding_source_error enum value to the //// response property for the response status

    • warning

      added the new funding_source_missing_configuration enum value to the //// response property for the response status

    • warning

      added the new funding_source_missing_configuration enum value to the //// response property for the response status

    • warning

      added the new funding_source_missing_configuration enum value to the //// response property for the response status

    • warning

      added the new funding_source_registration_in_progress enum value to the //// response property for the response status

    • warning

      added the new funding_source_registration_in_progress enum value to the //// response property for the response status

    • warning

      added the new funding_source_registration_in_progress enum value to the //// response property for the response status

    • warning

      added the new insurance_failure enum value to the //// response property for the response status

    • warning

      added the new insurance_failure enum value to the //// response property for the response status

    • warning

      added the new insurance_failure enum value to the //// response property for the response status

    • warning

      added the new service_not_determined enum value to the //// response property for the response status

    • warning

      added the new service_not_determined enum value to the //// response property for the response status

    • warning

      added the new service_not_determined enum value to the //// response property for the response status

    • warning

      added the new shipping_rule_not_found enum value to the //// response property for the response status

    • warning

      added the new shipping_rule_not_found enum value to the //// response property for the response status

    • warning

      added the new shipping_rule_not_found enum value to the //// response property for the response status