Get Account Status

Developer Preview

This endpoint retrieves the status of an account with the local delivery service provider from your app. The status determines if delivery operations are allowed, such as getting an estimate or ordering a delivery.

Wix calls this endpoint, for example, when the Delivery Area dashboard page is loaded.

You cannot try out this endpoint because it has to be implemented by an app and can have an arbitrary URL. So please ignore the Authorization and POST sections below as well as the Try It Out button.

Syntax

function GetAccount Status(accountId: string): GetAccountStatus<_com_wixpress_localdelivery_spi_v2_GetAccountStatusResponse>

Get Account Status Parameters

NAME

TYPE

DESCRIPTION

accountId

Required

string

Account ID.

Returns

Return Type:

object

NAME

TYPE

DESCRIPTION

status

string

Supported values: UNKNOWN, CREATED, ACTIVE, INACTIVE.

Status of the account with the local delivery service provider.

Was this helpful?

Get account status - decoded JWT

The data payload will include the following object as an encoded JWT. For the purposes of this example, we show the request and response objects decoded.

Request

curl

Copy Code

1curl -X POST https://provider.example.com/v2/get-account-status \
2    -H 'user-agent: Wix' \
3    -H 'accept-encoding: gzip, deflate' \
4    -H 'content-type: text/plain; charset=utf-8' \
5    -d '{
6          "data": {
7            "request": {
8              "accountId": "accountId"
9            },
10            "metadata": {
11              "requestId": "1655817281.2812834757191238478",
12              "instanceId": "fed6308a-159b-4f11-b98c-f75ff69b193a"
13            }
14          },
15          "aud": "ea9cd136-90ef-49b3-9a0c-67c6062aaaa8",
16          "iss": "wix.com",
17          "iat": 1655819679,
18          "exp": 1659419679
19        }'

Response

json

1{"status": "ACTIVE"}