Placewise API

Show Store Department By Department ID

Pending

GET

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

API Permit:Stores:Api:Departments:Get

API Context:Loyalty Club

Authorizations:UserToken

URL Parameters

Parameter	Description	Type
department_id	Department id from customer system	integer

Error Responses

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

Example

When successful, returns department object structured like below. Some values may be omitted if were not provided:

{
  "id": 12345,
  "department_id": 67890,
  "name": "Department/Mall name"
}

When id is invalid (422), returns:

{
    "error": "Department/Mall not found"
}

Return department by one of two identifiers: id or department_id

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

department_id

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 GET 'https://api.mpc.dev.placewise.com/v3/infinity-mall/stores/departments/by_department_id/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

List Store Departments

Create Store Department

Show Store Department By Department ID

URL Parameters#

Error Responses#

Example#

Request

Request samples

Responses

URL Parameters

Error Responses

Example