Placewise API

Update Store Department

Pending

PUT

https://api.mpc.dev.placewise.com/v3/{loyalty_club_slug}/stores/departments/{id}

API Permit:Stores:Api:Departments:Update

API Context:Loyalty Club

Authorizations:UserToken

Update department

URL Parameters

Parameter	Description	Type
id	ID	integer

Body Parameters

Parameter	Description	Type
name*	department name	string

Parameters with * are required

Feedback statuses

Status	Description
ok	Department updated
Department with this id does not exist.

Error Responses

Status	Description
`422`	Invalid parameters (see example on the right)

Example

When successful, returns a feedback object structured like this:

{
    "id": 12345,
    "department_id": 6789,
    "status": "ok"
}

When request is invalid (422), returns:

{
    "error": "Invalid format",
    "details": {
        "name": "The property {property} is required"
    }
}

When id or department_id is invalid (422), returns:

{
    "error": "Department not found"
}

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

integer

required

Example:

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.mpc.dev.placewise.com/v3/infinity-mall/stores/departments/1' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-05-07 15:48:35

Update Store Department by Department ID

Introduction

Update Store Department

URL Parameters#

Body Parameters#

Feedback statuses#

Error Responses#

Example#

Request

Request samples

Responses

URL Parameters

Body Parameters

Feedback statuses

Error Responses

Example