--- title: Create Location slug: api-documentation/create-location docTags: createdAt: 2026-08-27T16:56:29.420Z --- { "id": "L01CMZfbjdm1A0f1Apc7l", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/location", "servers": [ { "url": "https://api.upstartcommerce.com/v1/location" } ], "name": "Create Location", "description": "

This endpoint allows administrators to create a new location.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." }, { "kind": "optional", "name": "x-upstart-site", "type": "string", "description": "Unique identifier for the site." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The location to create.", "customType": "CreateLocation", "schema": [ { "name": "address", "kind": "required", "type": "object", "description": "

A postal address, broken into street, city, county, state or region, postal code and country.

", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "city", "kind": "required", "type": "string", "description": "" }, { "name": "country", "kind": "required", "type": "string", "description": "

The country associated with the location, applying the 2-character country code.

", "pattern": "^[A-Z]{2}$" }, { "name": "county", "kind": "optional", "type": "string", "description": "" }, { "name": "postalCode", "kind": "required", "type": "string", "description": "" }, { "name": "stateOrRegion", "kind": "required", "type": "string", "description": "" }, { "name": "street1", "kind": "required", "type": "string", "description": "" }, { "name": "street2", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "avgRating", "kind": "optional", "type": "number", "description": "An optional rating provided by an external ratings and reviews framework.", "format": "double" }, { "name": "contactInformation", "kind": "required", "type": "map", "description": "

This allows for a set of key-value pairs to provide contact information (e.g. phone number: 8885551212).

", "example": "", "customType": "map", "schema": [] }, { "name": "content", "kind": "optional", "type": "array", "description": "A place to hold a set of content associated with the location.", "modelRef": "#/components/schemas/Content", "customType": "Content[]", "schema": [ { "name": "content", "kind": "required", "type": "string", "description": "

The raw content-body to be displayed (HTML is acceptable).

" }, { "name": "endDateTime", "kind": "optional", "type": "string", "description": "

This allows for filtering a content item out based on an expiration date/time.

", "format": "date-time" }, { "name": "identifier", "kind": "required", "type": "string", "description": "

The key that should be used to reference this content item (e.g. HomePageBannerText)

" }, { "name": "startDateTime", "kind": "optional", "type": "string", "description": "This allows for filtering the content item out based on active date.", "format": "date-time" } ] }, { "name": "coordinates", "kind": "required", "type": "object", "description": "

Latitude/longitude-based coordinates.

", "modelRef": "#/components/schemas/Coordinates", "customType": "Coordinates", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": -90, "maximum": 90 }, { "name": "longitude", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": -180, "maximum": 180 } ] }, { "name": "dateOriginallyOpened", "kind": "optional", "type": "string", "description": "Date on which the location first opened.", "format": "date" }, { "name": "deliveryAvailable", "kind": "optional", "type": "boolean", "description": "This flag allows for the location to be identified as having a delivery option.", "default": false }, { "name": "directionsSummary", "kind": "optional", "type": "string", "description": "

This should be mark up text with a summary of how to reach the location (e.g. driving directions).

" }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "

This allows for a set of predefined custom fields to be created that are unique to a given client/tenant.

", "example": "", "schema": [] }, { "name": "externalApplicationReferences", "kind": "optional", "type": "map", "description": "

This map allows for the location to have a defined set of references to an external application (e.g. a unique URL to an appointment-scheduling app or to a specific Facebook page).

", "example": "", "customType": "map", "schema": [] }, { "name": "pickupHours", "kind": "optional", "type": "array", "description": "An array with one entry for each day of the week.", "modelRef": "#/components/schemas/NormalHoursOfOperation", "customType": "NormalHoursOfOperation[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "day", "kind": "required", "type": "string", "description": "

A reference to the day/s of the week that these hours apply to.

", "modelRef": "#/components/schemas/DayOfWeek", "customType": "DayOfWeek", "schema": [] }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is open; to be set for each day of the week. If true, set open and closed hours.

", "example": false }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "hoursOfOperation", "kind": "optional", "type": "array", "description": "An array with one entry for each day of the week.", "modelRef": "#/components/schemas/NormalHoursOfOperation", "customType": "NormalHoursOfOperation[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "day", "kind": "required", "type": "string", "description": "

A reference to the day/s of the week that these hours apply to.

", "modelRef": "#/components/schemas/DayOfWeek", "customType": "DayOfWeek", "schema": [] }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is open; to be set for each day of the week. If true, set open and closed hours.

", "example": false }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "id", "kind": "optional", "type": "string", "description": "Identifier of a location.", "modelRef": "#/components/schemas/LocationId", "customType": "LocationId", "schema": [] }, { "name": "locationType", "kind": "required", "type": "string", "description": "

A string indicating the type of location this is (e.g. kiosk, store, warehouse etc.).

" }, { "name": "media", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "name": "name", "kind": "required", "type": "string", "description": "

A user-friendly name for this location.

" }, { "name": "numReviews", "kind": "optional", "type": "integer", "description": "

In the case that this location has reviews associated with it, this is the total number of reviews.

", "format": "int32", "minimum": 0 }, { "name": "operational", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is currently operational (i.e. active, not related to opening hours).

", "example": true }, { "name": "operationHoursExceptions", "kind": "optional", "type": "array", "description": "

A set of exceptions to the normal business hours (e.g. holidays).

", "modelRef": "#/components/schemas/OperationHoursException", "customType": "OperationHoursException[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "exceptionType", "kind": "required", "type": "string", "description": "

Categorization of the reason for the exception to normal hours (e.g. holiday, private event).

" }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "This flag indicates whether the location is open." }, { "name": "name", "kind": "required", "type": "string", "description": "

A user-friendly name for this exception.

", "example": "Memorial Day" }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "pickupHoursExceptions", "kind": "optional", "type": "array", "description": "

A set of exceptions to the normal business hours (e.g. holidays).

", "modelRef": "#/components/schemas/OperationHoursException", "customType": "OperationHoursException[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "exceptionType", "kind": "required", "type": "string", "description": "

Categorization of the reason for the exception to normal hours (e.g. holiday, private event).

" }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "This flag indicates whether the location is open." }, { "name": "name", "kind": "required", "type": "string", "description": "

A user-friendly name for this exception.

", "example": "Memorial Day" }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "pickupAvailable", "kind": "optional", "type": "boolean", "description": "This flag indicates whether a consumer can use this location to pick up their order.", "default": false }, { "name": "pricingZone", "kind": "optional", "type": "string", "description": "This identifies which pricing zone should be used for calculating prices when the consumer is shopping this location.", "default": "NTL" }, { "name": "public", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is available to the public (e.g. a store as opposed to a warehouse).

", "example": true }, { "name": "remodelDates", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "2019-05-29", "itemDefault": "" }, { "name": "siteIds", "kind": "optional", "type": "array", "description": "A set of identifiers for the sites that this location is available on.", "modelRef": "#/components/schemas/SiteId", "customType": "SiteId[]", "schema": [] } ], "modelRef": "#/components/schemas/CreateLocation", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "

Success-location created.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

A physical location, with its addresses, contact details, opening hours and the sites it serves.

", "customType": "Location", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Identifier of a location.", "modelRef": "#/components/schemas/LocationId", "customType": "LocationId", "schema": [] }, { "name": "name", "kind": "required", "type": "string", "description": "

A user-friendly name for this location.

" }, { "name": "siteIds", "kind": "optional", "type": "array", "description": "A set of identifiers for the sites that this location is available on.", "modelRef": "#/components/schemas/SiteId", "customType": "SiteId[]", "schema": [] }, { "name": "locationType", "kind": "required", "type": "string", "description": "

A string indicating the type of location this is (e.g. kiosk, store, warehouse etc.).

" }, { "name": "public", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is available to the public (e.g. a store as opposed to a warehouse).

", "example": true }, { "name": "operational", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is currently operational (i.e. active, not related to opening hours).

", "example": true }, { "name": "address", "kind": "required", "type": "object", "description": "

A postal address, broken into street, city, county, state or region, postal code and country.

", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "city", "kind": "required", "type": "string", "description": "" }, { "name": "country", "kind": "required", "type": "string", "description": "

The country associated with the location, applying the 2-character country code.

", "pattern": "^[A-Z]{2}$" }, { "name": "county", "kind": "optional", "type": "string", "description": "" }, { "name": "postalCode", "kind": "required", "type": "string", "description": "" }, { "name": "stateOrRegion", "kind": "required", "type": "string", "description": "" }, { "name": "street1", "kind": "required", "type": "string", "description": "" }, { "name": "street2", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "coordinates", "kind": "required", "type": "object", "description": "

Latitude/longitude-based coordinates.

", "modelRef": "#/components/schemas/Coordinates", "customType": "Coordinates", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": -90, "maximum": 90 }, { "name": "longitude", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": -180, "maximum": 180 } ] }, { "name": "contactInformation", "kind": "required", "type": "map", "description": "

This allows for a set of key-value pairs to provide contact information (e.g. phone number: 8885551212).

", "example": "", "customType": "map", "schema": [] }, { "name": "operationHoursExceptions", "kind": "optional", "type": "array", "description": "

A set of exceptions to the normal business hours (e.g. holidays).

", "modelRef": "#/components/schemas/OperationHoursException", "customType": "OperationHoursException[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "exceptionType", "kind": "required", "type": "string", "description": "

Categorization of the reason for the exception to normal hours (e.g. holiday, private event).

" }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "This flag indicates whether the location is open." }, { "name": "name", "kind": "required", "type": "string", "description": "

A user-friendly name for this exception.

", "example": "Memorial Day" }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "pickupHoursExceptions", "kind": "optional", "type": "array", "description": "

A set of exceptions to the normal business hours (e.g. holidays).

", "modelRef": "#/components/schemas/OperationHoursException", "customType": "OperationHoursException[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "exceptionType", "kind": "required", "type": "string", "description": "

Categorization of the reason for the exception to normal hours (e.g. holiday, private event).

" }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "This flag indicates whether the location is open." }, { "name": "name", "kind": "required", "type": "string", "description": "

A user-friendly name for this exception.

", "example": "Memorial Day" }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "dateOriginallyOpened", "kind": "optional", "type": "string", "description": "Date on which the location first opened.", "format": "date" }, { "name": "remodelDates", "kind": "optional", "type": "array", "description": "", "example": "[\"2019-05-29\"]", "itemType": "string", "customType": "string[]", "itemExample": "2019-05-29", "itemDefault": "" }, { "name": "externalApplicationReferences", "kind": "optional", "type": "map", "description": "

This map allows for the location to have a defined set of references to an external application (e.g. a unique URL to an appointment-scheduling app or to a specific Facebook page).

", "example": "", "customType": "map", "schema": [] }, { "name": "content", "kind": "optional", "type": "array", "description": "A place to hold a set of content associated with the location.", "modelRef": "#/components/schemas/Content", "customType": "Content[]", "schema": [ { "name": "content", "kind": "required", "type": "string", "description": "

The raw content-body to be displayed (HTML is acceptable).

" }, { "name": "endDateTime", "kind": "optional", "type": "string", "description": "

This allows for filtering a content item out based on an expiration date/time.

", "format": "date-time" }, { "name": "identifier", "kind": "required", "type": "string", "description": "

The key that should be used to reference this content item (e.g. HomePageBannerText)

" }, { "name": "startDateTime", "kind": "optional", "type": "string", "description": "This allows for filtering the content item out based on active date.", "format": "date-time" } ] }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "

This allows for a set of predefined custom fields to be created that are unique to a given client/tenant.

", "example": "", "schema": [] }, { "name": "pricingZone", "kind": "optional", "type": "string", "description": "This identifies which pricing zone should be used for calculating prices when the consumer is shopping this location.", "default": "NTL" }, { "name": "pickupAvailable", "kind": "optional", "type": "boolean", "description": "This flag indicates whether a consumer can use this location to pick up their order.", "default": false }, { "name": "deliveryAvailable", "kind": "optional", "type": "boolean", "description": "This flag allows for the location to be identified as having a delivery option.", "default": false }, { "name": "numReviews", "kind": "optional", "type": "integer", "description": "

In the case that this location has reviews associated with it, this is the total number of reviews.

", "format": "int32", "minimum": 0 }, { "name": "avgRating", "kind": "optional", "type": "number", "description": "An optional rating provided by an external ratings and reviews framework.", "format": "double" }, { "name": "directionsSummary", "kind": "optional", "type": "string", "description": "

This should be mark up text with a summary of how to reach the location (e.g. driving directions).

" }, { "name": "hoursOfOperation", "kind": "optional", "type": "array", "description": "An array with one entry for each day of the week.", "modelRef": "#/components/schemas/NormalHoursOfOperation", "customType": "NormalHoursOfOperation[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "day", "kind": "required", "type": "string", "description": "

A reference to the day/s of the week that these hours apply to.

", "modelRef": "#/components/schemas/DayOfWeek", "customType": "DayOfWeek", "schema": [] }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is open; to be set for each day of the week. If true, set open and closed hours.

", "example": false }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "pickupHours", "kind": "optional", "type": "array", "description": "An array with one entry for each day of the week.", "modelRef": "#/components/schemas/NormalHoursOfOperation", "customType": "NormalHoursOfOperation[]", "schema": [ { "name": "closed", "kind": "optional", "type": "string", "description": "

The local time at which the location closes in 24-hour notation.

", "example": 1200, "pattern": "[0-2][0-9]:[0-5][0-9]" }, { "name": "day", "kind": "required", "type": "string", "description": "

A reference to the day/s of the week that these hours apply to.

", "modelRef": "#/components/schemas/DayOfWeek", "customType": "DayOfWeek", "schema": [] }, { "name": "isOpen", "kind": "required", "type": "boolean", "description": "

This flag indicates whether the location is open; to be set for each day of the week. If true, set open and closed hours.

", "example": false }, { "name": "open", "kind": "optional", "type": "string", "description": "

The local time at which the location opens in 24-hour notation.

", "example": "08:00", "pattern": "[0-2][0-9]:[0-5][0-9]" } ] }, { "name": "media", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/Location", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload returned when a request fails validation, identifying the offending input by name, code and detail.

", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "WISjJmqU94bVP3mrp1WLy", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/location \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrRegion\": \"\",\n \"street1\": \"\"\n },\n \"contactInformation\": \"\",\n \"content\": [\n {\n \"content\": \"\",\n \"identifier\": \"\"\n }\n ],\n \"coordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"pickupHours\": [\n {\n \"day\": \"\",\n \"isOpen\": false\n }\n ],\n \"hoursOfOperation\": [\n {\n \"day\": \"\",\n \"isOpen\": false\n }\n ],\n \"locationType\": \"\",\n \"name\": \"\",\n \"operational\": true,\n \"operationHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pickupHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pricingZone\": \"NTL\",\n \"public\": true\n }'" }, { "id": "Q24Ek-GJQCLzBghWAZjad", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrRegion\": \"\",\n \"street1\": \"\"\n },\n \"contactInformation\": \"\",\n \"content\": [\n {\n \"content\": \"\",\n \"identifier\": \"\"\n }\n ],\n \"coordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"pickupHours\": [\n {\n \"day\": \"\",\n \"isOpen\": false\n }\n ],\n \"hoursOfOperation\": [\n {\n \"day\": \"\",\n \"isOpen\": false\n }\n ],\n \"locationType\": \"\",\n \"name\": \"\",\n \"operational\": true,\n \"operationHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pickupHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pricingZone\": \"NTL\",\n \"public\": true\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/location\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "sQIfncbB5Nq9MfRii05-Z", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/location\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrRegion\": \"\",\n \"street1\": \"\"\n },\n \"contactInformation\": \"\",\n \"content\": [\n {\n \"content\": \"\",\n \"identifier\": \"\"\n }\n ],\n \"coordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"pickupHours\": [\n {\n \"day\": \"\",\n \"isOpen\": false\n }\n ],\n \"hoursOfOperation\": [\n {\n \"day\": \"\",\n \"isOpen\": false\n }\n ],\n \"locationType\": \"\",\n \"name\": \"\",\n \"operational\": true,\n \"operationHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pickupHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pricingZone\": \"NTL\",\n \"public\": true\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "x2aeqHquJoiWJ1hIv_mVw", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/location\"\n\npayload = json.dumps({\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrRegion\": \"\",\n \"street1\": \"\"\n },\n \"contactInformation\": \"\",\n \"content\": [\n {\n \"content\": \"\",\n \"identifier\": \"\"\n }\n ],\n \"coordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"pickupHours\": [\n {\n \"day\": \"\",\n \"isOpen\": False\n }\n ],\n \"hoursOfOperation\": [\n {\n \"day\": \"\",\n \"isOpen\": False\n }\n ],\n \"locationType\": \"\",\n \"name\": \"\",\n \"operational\": True,\n \"operationHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pickupHoursExceptions\": [\n {\n \"exceptionType\": \"\",\n \"isOpen\": \"\",\n \"name\": \"Memorial Day\"\n }\n ],\n \"pricingZone\": \"NTL\",\n \"public\": True\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "WISjJmqU94bVP3mrp1WLy" }, "results": { "languages": [ { "id": "tolUjInRp_b4kMO9w5u2T", "language": "201", "code": "// Success-location created.\n{\n \"id\": \"\",\n \"name\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"locationType\": \"\",\n \"public\": true,\n \"operational\": true,\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postalCode\": \"\",\n \"stateOrRegion\": \"\",\n \"street1\": \"\",\n \"street2\": \"\"\n },\n \"coordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"contactInformation\": \"\",\n \"operationHoursExceptions\": [\n {\n \"closed\": 1200,\n \"exceptionType\": \"\",\n \"isOpen\": false,\n \"name\": \"Memorial Day\",\n \"open\": \"08:00\"\n }\n ],\n \"pickupHoursExceptions\": [\n {\n \"closed\": 1200,\n \"exceptionType\": \"\",\n \"isOpen\": false,\n \"name\": \"Memorial Day\",\n \"open\": \"08:00\"\n }\n ],\n \"dateOriginallyOpened\": \"\",\n \"remodelDates\": [\n \"2019-05-29\"\n ],\n \"externalApplicationReferences\": \"\",\n \"content\": [\n {\n \"content\": \"\",\n \"endDateTime\": \"\",\n \"identifier\": \"\",\n \"startDateTime\": \"\"\n }\n ],\n \"dynamicProperties\": {},\n \"pricingZone\": \"\",\n \"pickupAvailable\": false,\n \"deliveryAvailable\": false,\n \"numReviews\": \"\",\n \"avgRating\": \"\",\n \"directionsSummary\": \"\",\n \"hoursOfOperation\": [\n {\n \"closed\": 1200,\n \"day\": \"\",\n \"isOpen\": false,\n \"open\": \"08:00\"\n }\n ],\n \"pickupHours\": [\n {\n \"closed\": 1200,\n \"day\": \"\",\n \"isOpen\": false,\n \"open\": \"08:00\"\n }\n ],\n \"media\": \"\"\n}" }, { "id": "JVC2zRa_4fEuFW3YdvuIt", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "wJPZN1yx5RRp_s40osWKQ", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "tolUjInRp_b4kMO9w5u2T" } }, "children": [ { "text": "" } ] }