Update a point of sale

PATCH /manager/points-of-sale/{id}

Bearer token

Path parameters

id integer(int32) Required

The id of the point of sale

application/json

Body Required

active boolean
external_id string(nullable)
labels array[object]
Hide labels attributes Show labels attributes object
- lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
- content string
descriptions array[object]
Hide descriptions attributes Show descriptions attributes object
- lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
- content string
hours array[object]
Hide hours attributes Show hours attributes object
- lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
- content string
pos_type integer(int32)

Values are 1, 2, 3, 4, 5, 6, 7, or 8.
phone string(nullable)
email string(nullable)
external_url string(nullable)

Responses

200 application/json

returns the updated point of sale
Hide response attributes Show response attributes object
- id_point_of_sale integer(int32)
- date_insert string(nullable)
- date_update string(nullable)
- active boolean
- external_id string(nullable)
- pos_type integer(int32)
- phone string(nullable)
- email string(nullable)
- external_url string(nullable)
- members array[object]
  
  Hide members attributes Show members attributes object
  
  id_ambassador integer(int32)
  
  image string
  
  firstname string
  
  lastname string
  
  username string
  
  email string
  
  email_tmp string
  
  active integer(int32)
  
  status integer(int32)
  
  online boolean
  
  true: when last_action_date is less than 5 minutes ago
  
  last_action_date string(date-time)
  
  customer_id string
  
  anonymized boolean
- address_geocode object
  
  Additional properties are allowed.
  
  Hide address_geocode attributes Show address_geocode attributes object
  
  date_insert string(date-time)
  
  date_update string(date-time)
  
  latitude string
  
  longitude string
  
  city string
  
  country string
  
  postcode string
  
  street string
  
  street2 string
- labels array[object]
  
  Hide labels attributes Show labels attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
- descriptions array[object]
  
  Hide descriptions attributes Show descriptions attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
- hours array[object]
  
  Hide hours attributes Show hours attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
401 application/json

Unauthorized.
Hide response attribute Show response attribute object
- message string
403

Forbidden - You don't have permission to access this route
404

Not found
422 application/json

Unprocessable Content
Hide response attributes Show response attributes object
- message string
  
  Error message.
- errors object
  
  Hide errors attributes Show errors attributes object
  
  field array[string]
  
  Error message details.
  
  * array[string] Additional properties
  
  Error message details.

PATCH /manager/points-of-sale/{id}

curl \
 -X PATCH https://domain.tld/api/v2/manager/points-of-sale/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"active":true,"external_id":"string","labels":[{"lang":"en_GB","content":"Hello"}],"descriptions":[{"lang":"en_GB","content":"Hello"}],"hours":[{"lang":"en_GB","content":"Hello"}],"pos_type":1,"phone":"string","email":"string","external_url":"string"}'

Request examples

{
  "active": true,
  "external_id": "string",
  "labels": [
    {
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "descriptions": [
    {
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "hours": [
    {
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "pos_type": 1,
  "phone": "string",
  "email": "string",
  "external_url": "string"
}

Response examples (200)

{
  "id_point_of_sale": 42,
  "date_insert": "string",
  "date_update": "string",
  "active": true,
  "external_id": "string",
  "pos_type": 42,
  "phone": "string",
  "email": "string",
  "external_url": "string",
  "members": [
    {
      "id_ambassador": 42,
      "image": "string",
      "firstname": "string",
      "lastname": "string",
      "username": "string",
      "email": "string",
      "email_tmp": "string",
      "active": 42,
      "status": 42,
      "online": true,
      "last_action_date": "2024-05-04T09:42:00+00:00",
      "customer_id": "string",
      "anonymized": true
    }
  ],
  "address_geocode": {
    "date_insert": "2024-05-04T09:42:00+00:00",
    "date_update": "2024-05-04T09:42:00+00:00",
    "latitude": "48.856614",
    "longitude": "2.3522219",
    "city": "Paris",
    "country": "France",
    "postcode": "75001",
    "street": "Rue de Rivoli",
    "street2": "Place de la Concorde"
  },
  "labels": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "descriptions": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "hours": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ]
}

Response examples (401)

{
  "message": "Unauthorized."
}

Response examples (422)

{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}