# Create Store

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v4/stores:
    post:
      summary: Create Store
      deprecated: false
      description: ''
      tags:
        - API Reference/Management API/Stores/V4 API/Stores
      parameters:
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                store: &ref_0
                  $ref: '#/components/schemas/Store'
              x-apidog-orders:
                - store
              required:
                - store
              x-apidog-ignore-properties: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  store: *ref_0
                x-apidog-orders:
                  - store
                required:
                  - store
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Success
        '422':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    examples:
                      - Invalid parameters
                    const: Invalid parameters
                  details:
                    type: object
                    properties: {}
                    x-apidog-orders: []
                    description: 'See: [Params Validation](doc-341637)'
                    additionalProperties: true
                    x-apidog-ignore-properties: []
                required:
                  - error
                  - details
                x-apidog-orders:
                  - error
                  - details
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Invalid Parameters
      security: []
      x-apidog-folder: API Reference/Management API/Stores/V4 API/Stores
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511053-run
components:
  schemas:
    Store:
      type: object
      properties:
        id: &ref_3
          $ref: '#/components/schemas/id'
          readOnly: true
        retailer_id:
          type: integer
          description: ID of [Retailer](doc-341693) the Store belongs to
          minimum: 1
          format: uint64
          examples:
            - 54
          nullable: true
        name:
          type: string
          examples:
            - Infinity Store
        slug:
          type: string
          examples:
            - infinity-store
          description: When not provided, it's auto-generated from name
        type:
          type: string
          enum:
            - store
            - cinema
            - dining
            - office
          x-apidog-enum:
            - value: store
              name: ''
              description: ''
            - value: cinema
              name: ''
              description: ''
            - value: dining
              name: ''
              description: ''
            - value: office
              name: ''
              description: ''
          default: store
          examples:
            - store
        description:
          anyOf:
            - &ref_1
              $ref: '#/components/schemas/LocalizedContent'
            - type: 'null'
        zip_code:
          type: string
          examples:
            - 33-232
          nullable: true
        region:
          type: string
          examples:
            - Shire
          nullable: true
        address:
          type: string
          examples:
            - Bag End
          nullable: true
        city:
          type: string
          examples:
            - Hobbiton
          nullable: true
        phone_number:
          anyOf:
            - &ref_4
              $ref: '#/components/schemas/msisdn'
            - type: 'null'
        email:
          anyOf:
            - &ref_5
              $ref: '#/components/schemas/email'
            - type: 'null'
        website_url:
          anyOf:
            - &ref_6
              $ref: '#/components/schemas/url'
            - type: 'null'
        website_text:
          anyOf:
            - *ref_1
            - type: 'null'
          description: Text to display along page Website URL
        location_description:
          anyOf:
            - *ref_1
            - type: 'null'
          description: Text describing Store location within Venue
        map_key:
          type: string
          examples:
            - '55'
          description: Identifier of Store on the virtual map
          nullable: true
        social_profiles: &ref_7
          properties:
            facebook:
              type: string
            twitter:
              type: string
          required:
            - facebook
            - twitter
          x-apidog-orders:
            - facebook
            - twitter
          $ref: '#/components/schemas/cms.social_profiles'
        opening_hours:
          anyOf:
            - $ref: '#/components/schemas/OpeningHoursList'
            - type: 'null'
        opening_hours_text: *ref_1
        opening_hours_inherited:
          type: boolean
          description: >-
            When true, Public API returns opening hours of the whole venue as
            opening hours of this Store
          default: false
        status:
          $ref: '#/components/schemas/cms.status'
        status_message: *ref_1
        locales:
          $ref: '#/components/schemas/cms.locales'
        products:
          $ref: '#/components/schemas/cms.products'
        sorting_priority:
          $ref: '#/components/schemas/cms.sorting_priority'
        receipt_names:
          type: array
          items:
            type: string
          description: Alternative name "hints" for OCR
        receipt_addresses:
          type: array
          items:
            type: string
          description: Alternative address "hints" for OCR
        receipt_scan_limits_inherited:
          type: boolean
          description: >-
            When true, Store inherits property-level scan limits configured on
            LoyaltyClubConfiguration. When false, uses own receipt_store_limit_*
            and receipt_member_in_store_limit_* values.
          default: true
        receipt_store_limit_per_month:
          type: integer
          minimum: 1
          description: >-
            Per-month cap of accepted receipts against this store across all
            members. Null means inherit property default.
          nullable: true
        receipt_member_in_store_limit_per_day:
          type: integer
          minimum: 1
          description: >-
            Per-day cap of accepted receipts per single member in this store.
            Null means inherit property default.
          nullable: true
        receipt_member_in_store_limit_per_month:
          type: integer
          minimum: 1
          description: >-
            Per-month cap of accepted receipts per single member in this store.
            Null means inherit property default.
          nullable: true
        created_at: &ref_8
          $ref: '#/components/schemas/date_time.created_at'
          readOnly: true
        updated_at: &ref_9
          $ref: '#/components/schemas/date_time.updated_at'
          readOnly: true
        discarded_at:
          $ref: '#/components/schemas/date_time.archived_at'
          readOnly: true
        logo: &ref_2
          $ref: '#/components/schemas/File'
          readOnly: true
          description: |
            Must be uploaded as a file of type: store_logo
        images:
          type: array
          items: *ref_2
          readonly: true
          readOnly: true
          description: 'Must be uploaded as a file of type: store_image'
        retailer:
          anyOf:
            - $ref: '#/components/schemas/Retailer'
            - type: 'null'
          readOnly: true
          description: '[Retailer](doc-341693) the Store belongs to'
        categories:
          type: array
          items:
            type: object
            properties:
              id: *ref_3
              slug: *ref_1
              title: *ref_1
            x-apidog-orders:
              - id
              - slug
              - title
            required:
              - id
              - slug
              - title
            x-apidog-ignore-properties: []
          readOnly: true
          description: '[Categories](doc-341694) of the Store'
        us_legacy_data:
          type: object
          properties: {}
          x-apidog-orders: []
          description: Internal
          x-apidog-ignore-properties: []
          nullable: true
        national_deals_sync_policy_mode:
          type: string
          description: Internal
          examples:
            - publish
          default: publish
          enum:
            - draft
            - disabled
            - publish
          x-apidog-enum:
            - value: draft
              name: ''
              description: ''
            - value: disabled
              name: ''
              description: ''
            - value: publish
              name: ''
              description: ''
          nullable: true
        external_master:
          type: string
          description: Internal
          nullable: true
        external_id:
          type: string
          description: External id of the store from provider
          nullable: true
        external_url:
          type: string
          x-apidog-mock: '{{$internet.url}}'
          description: Store webisite outside of CMS (from scraped website for example)
          nullable: true
        floor:
          type: string
          description: Floor filter used by TC module
        representations:
          $ref: '#/components/schemas/cms.store_representation'
      required:
        - id
        - retailer_id
        - name
        - slug
        - description
        - zip_code
        - region
        - address
        - city
        - phone_number
        - email
        - website_url
        - website_text
        - location_description
        - map_key
        - social_profiles
        - opening_hours
        - opening_hours_text
        - opening_hours_inherited
        - status
        - status_message
        - locales
        - products
        - sorting_priority
        - receipt_names
        - receipt_addresses
        - receipt_scan_limits_inherited
        - receipt_store_limit_per_month
        - receipt_member_in_store_limit_per_day
        - receipt_member_in_store_limit_per_month
        - created_at
        - updated_at
        - discarded_at
        - logo
        - images
        - retailer
        - categories
        - us_legacy_data
        - national_deals_sync_policy_mode
        - external_master
        - external_url
        - representations
      x-apidog-orders:
        - id
        - retailer_id
        - name
        - slug
        - type
        - description
        - zip_code
        - region
        - address
        - city
        - phone_number
        - email
        - website_url
        - website_text
        - location_description
        - map_key
        - social_profiles
        - opening_hours
        - opening_hours_text
        - opening_hours_inherited
        - status
        - status_message
        - locales
        - products
        - sorting_priority
        - receipt_names
        - receipt_addresses
        - receipt_scan_limits_inherited
        - receipt_store_limit_per_month
        - receipt_member_in_store_limit_per_day
        - receipt_member_in_store_limit_per_month
        - created_at
        - updated_at
        - discarded_at
        - logo
        - images
        - retailer
        - categories
        - us_legacy_data
        - national_deals_sync_policy_mode
        - external_master
        - external_id
        - external_url
        - floor
        - representations
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    cms.store_representation:
      type: array
      items:
        type: string
        enum:
          - directory
          - operations
          - receipt_scanning
        x-apidog-enum:
          - value: directory
            name: ''
            description: ''
          - value: operations
            name: ''
            description: ''
          - value: receipt_scanning
            name: ''
            description: ''
      x-apidog-folder: ''
    Retailer:
      type: object
      properties:
        id: *ref_3
        name:
          type: string
          examples:
            - Placewise
        slug:
          type: string
          description: When not provided, it's auto-generated from name
          examples:
            - slug
        country:
          $ref: '#/components/schemas/country'
        description:
          anyOf:
            - *ref_1
            - type: 'null'
        phone_number:
          anyOf:
            - *ref_4
            - type: 'null'
        email:
          anyOf:
            - *ref_5
            - type: 'null'
        website_url:
          description: Address of the external website of Retailer/Retailer
          anyOf:
            - *ref_6
            - type: 'null'
        logo:
          description: 'Must be uploaded as a file of type: retailer_logo'
          anyOf:
            - *ref_2
            - type: 'null'
        us_legacy_data:
          anyOf:
            - $ref: '#/components/schemas/cms.us_legacy_data'
            - type: 'null'
        external_master:
          anyOf:
            - $ref: '#/components/schemas/cms.external_master'
            - type: 'null'
        social_profiles: *ref_7
        images:
          type: array
          items: *ref_2
          description: 'Must be uploaded as a file of type: retailer_image'
          readOnly: true
        created_at: *ref_8
        updated_at: *ref_9
      x-apidog-orders:
        - id
        - name
        - slug
        - country
        - description
        - phone_number
        - email
        - website_url
        - logo
        - us_legacy_data
        - external_master
        - social_profiles
        - images
        - created_at
        - updated_at
      required:
        - id
        - name
        - slug
        - country
        - description
        - phone_number
        - email
        - website_url
        - logo
        - us_legacy_data
        - external_master
        - social_profiles
        - images
        - created_at
        - updated_at
      readOnly: true
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    cms.external_master:
      type: string
      description: 'When present, the record is being synced from given external source '
      examples:
        - scraper
      x-apidog-folder: ''
    cms.us_legacy_data:
      type: object
      properties: {}
      x-apidog-orders: []
      description: Extra content for migrated content from legacy system
      additionalProperties: true
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    country:
      type: string
      description: '[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)'
      examples:
        - 'NO'
      x-apidog-folder: ''
    File:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          examples:
            - https://example.com/image.png
        identifier:
          type: string
          description: Only present when parent record has many files
          examples:
            - '1'
        mime_type:
          type: string
          examples:
            - image/jpeg
          readOnly: true
          description: Only present in certain circumstances
          nullable: true
        created_at:
          type: string
          format: date-time
          examples:
            - '2022-11-09T15:46:00.252860Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          examples:
            - '2022-11-09T15:46:00.252860Z'
        image_details:
          type: object
          properties:
            width:
              type: integer
              minimum: 1
            height:
              type: integer
              minimum: 1
          x-apidog-orders:
            - width
            - height
          x-apidog-ignore-properties: []
          nullable: true
      x-apidog-orders:
        - url
        - identifier
        - mime_type
        - created_at
        - updated_at
        - image_details
      required:
        - url
        - created_at
        - updated_at
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    date_time.archived_at:
      type: string
      description: Time of the record archivization
      format: date-time
      examples:
        - '2022-11-15T16:25:58.099512Z'
      readOnly: true
      nullable: true
      x-apidog-folder: ''
    date_time.updated_at:
      type: string
      description: Time of the last record update
      format: date-time
      examples:
        - '2022-11-15T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    date_time.created_at:
      type: string
      description: Time of record creation
      format: date-time
      examples:
        - '2022-11-05T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    cms.sorting_priority:
      type: integer
      description: >-
        Priority of the record during sorting in [CMS Public API](doc-341653).
        Currently read-only.
      examples:
        - 0
      x-apidog-folder: ''
    cms.products:
      type: array
      items:
        type: string
        examples:
          - test
      description: >-
        API products the record should be available to - see [X-Product-Name
        Header](doc-341635#x-locale-header)
      examples:
        - - website
      x-apidog-orders: []
      x-apidog-folder: ''
    cms.locales:
      type: array
      items:
        type: string
        examples:
          - test
      description: >-
        Locales the record should be available to - see:
        [Localization](doc-341959)
      examples:
        - - en
      x-apidog-orders: []
      x-apidog-folder: ''
    cms.status:
      type: string
      enum:
        - draft
        - published
        - unpublished
      examples:
        - published
      description: Determines visibility in [Public API](doc-341643)
      x-apidog-enum:
        - name: ''
          value: draft
          description: ''
        - name: ''
          value: published
          description: ''
        - name: ''
          value: unpublished
          description: ''
      x-apidog-folder: ''
    OpeningHoursList:
      type: array
      items:
        $ref: '#/components/schemas/OpeningHoursItem'
      description: 'See: [Opening Hours](doc-342133)'
      x-apidog-folder: ''
    OpeningHoursItem:
      type: object
      examples:
        - type: weekday
          period: monday
          hours:
            opens_at: '09:00'
            closes_at: '18:00'
          description:
            en: Text
        - type: weekday
          period: sunday
          hours:
            opens_at: '12:00'
            closes_at: '15:00'
          description:
            en: Text
        - type: day
          period: '2025-05-15'
          hours: null
          description:
            en: Closed
      properties:
        type:
          type: string
          examples:
            - weekday
          const: weekday
        period:
          anyOf:
            - description: 'For type: "day"'
              $ref: '#/components/schemas/date'
            - type: string
              enum:
                - monday
                - tuesday
                - wednesday
                - thursday
                - friday
                - saturday
                - sunday
              x-apidog-enum:
                - value: monday
                  name: ''
                  description: ''
                - value: tuesday
                  name: ''
                  description: ''
                - value: wednesday
                  name: ''
                  description: ''
                - value: thursday
                  name: ''
                  description: ''
                - value: friday
                  name: ''
                  description: ''
                - value: saturday
                  name: ''
                  description: ''
                - value: sunday
                  name: ''
                  description: ''
              description: 'For type: "weekday"'
        hours:
          type: object
          properties:
            opens_at:
              type: string
              description: Hour of entity opening time
              examples:
                - '09:00'
            closes_at:
              type: string
              description: |
                Hour of entity closing time
              examples:
                - '15:00'
          x-apidog-orders:
            - opens_at
            - closes_at
          required:
            - opens_at
            - closes_at
          description: When null, object is closed at this period
          x-apidog-ignore-properties: []
          nullable: true
        description: *ref_1
      x-apidog-orders:
        - type
        - period
        - hours
        - description
      readOnly: true
      required:
        - type
        - period
        - hours
      x-apidog-refs: {}
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date:
      type: string
      format: date
      examples:
        - '2023-01-15'
      x-apidog-folder: ''
    cms.social_profiles:
      type: object
      properties:
        facebook: *ref_6
        twitter: *ref_6
        instagram: *ref_6
        linkedin: *ref_6
        snapchat: *ref_6
        tiktok: *ref_6
        youtube: *ref_6
        pinterest: *ref_6
      x-apidog-orders:
        - facebook
        - twitter
        - instagram
        - linkedin
        - snapchat
        - tiktok
        - youtube
        - pinterest
      description: 'URLs on specific social media '
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    url:
      type: string
      examples:
        - https://example.com
      x-apidog-folder: ''
    email:
      type: string
      format: email
      examples:
        - somebody@example.com
      x-apidog-folder: ''
    msisdn:
      type: string
      description: '[E.164 MSISDN](https://en.wikipedia.org/wiki/E.164) '
      examples:
        - '4740769126'
      x-apidog-folder: ''
    LocalizedContent:
      type: object
      properties: {}
      x-apidog-orders: []
      title: ''
      examples:
        - en: Text
      additionalProperties:
        type: string
        description: >-
          The actual set of languages depends on LC configuration. See:
          [Localization](doc-341959)
        examples:
          - Tekst
        nullable: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    id:
      type: integer
      description: Primary identifier of the record
      format: uint64
      readOnly: true
      examples:
        - 1
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```