DeliveryProvider

DeliveryProvider

List delivery Providers

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/delivery-providers

List all delivery providers

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

querystringOptional

Query for the deliveryProvider

Responses

200

Example response

application/json

get/tenants/{tenantUid}/delivery-providers

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/delivery-providers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "name": "text",
      "externalId": "text",
      "deliveryProviderUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new delivery provider

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/delivery-providers

Create a new delivery provider

Required permissions: DELIVERY_METHOD

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

namestringRequired

externalIdstringOptional

deliveryProviderUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

201

Example response

application/json

namestringRequired

externalIdstringRequired

deliveryProviderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

post/tenants/{tenantUid}/delivery-providers

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/delivery-providers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

201

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

Get delivery provider details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}

Get delivery provider details

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

deliveryProviderUidstringRequired

Reference to a delivery provider.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

namestringRequired

externalIdstringRequired

deliveryProviderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

get/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

Update delivery provider details

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}

Update delivery provider details

Required permissions: DELIVERY_METHOD

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

deliveryProviderUidstringRequired

Reference to a delivery provider.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

namestringOptional

externalIdstringOptional

Responses

200

Example response

application/json

namestringRequired

externalIdstringRequired

deliveryProviderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

put/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "externalId": "text"
}

200

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

Delete an delivery provider

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}

Delete an delivery provider

Required permissions: DELIVERY_METHOD

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

deliveryProviderUidstringRequired

Reference to a delivery provider.

Pattern: ^[A-Za-z0-9-_]+

Responses

204

No Content

No content

delete/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content