Support

createLocation

View as Markdown

Create a new location.

mutation

Requires commerce.product:write.

Create a new location.

Required headers

HeaderRequiredDescription
x-store-idYesID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED".

Go to Authentication for credential setup.

Arguments

  • input MutationCreateLocationInput! required
    • address CreateAddressInput! required
      • addressLine1 String! required
      • countryCode String! required
      • addressDetails AddressDetailsInput optional
        • addressType String optional
        • buildingName String optional
        • deliveryService String optional
        • geoCoordinates GeoCoordinatesInput optional
        • streetName String optional
        • streetNumber String optional
        • streetType String optional
        • subBuilding String optional
      • addressLine2 String optional
      • addressLine3 String optional
      • adminArea1 String optional
      • adminArea2 String optional
      • adminArea3 String optional
      • adminArea4 String optional
      • postalCode String optional
    • label String! required
    • metafields [CreateMetafieldInput!] optional
      • key String! required
      • namespace String! required
      • type String! required — Metafield value type. Live catalog validation accepts lowercase values such as boolean, string, stringMultiLine, number, numberDecimal, date, dateTime, json, measurement, url, reference, money, list.string, list.number, list.numberDecimal. Uppercase STRING is rejected.
      • value String! required
    • name String optional
    • references [CreateReferenceInput!] optional
      • origin String! required
      • value String! required
    • status String optional — The status of the location, one of ACTIVE, INACTIVE, ARCHIVED.

Possible returns

  • Location Location — A location represents the physical location of an inventory.

Last updated on

How is this guide?