# DeliveryProvider

DeliveryProvider

## List delivery Providers

> List all delivery providers

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryProvider","description":"DeliveryProvider"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"},"deliveryProviderQuery":{"description":"Query for the deliveryProvider","in":"query","name":"query","required":false,"schema":{"type":"string"}}},"schemas":{"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"},"DeliveryProviderResponseSchema":{"title":"DeliveryProviderResponseSchema","type":"object","required":["name","externalId","deliveryProviderUid"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"}},"responses":{"DeliveryProviderListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProviderResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"]}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers":{"get":{"description":"List all delivery providers","operationId":"get-tenant-delivery-providers","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/deliveryProviderQuery"}],"responses":{"200":{"$ref":"#/components/responses/DeliveryProviderListResponse"}},"summary":"List delivery Providers","tags":["DeliveryProvider"]}}}}
```

## Create a new delivery provider

> Create a new delivery provider\
> \
> Required permissions: DELIVERY\_METHOD

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryProvider","description":"DeliveryProvider"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"DeliveryProviderCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderCreateRequestSchema"}}}}},"schemas":{"DeliveryProviderCreateRequestSchema":{"title":"DeliveryProviderCreateRequestSchema","type":"object","required":["name"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"DeliveryProviderResponseSchema":{"title":"DeliveryProviderResponseSchema","type":"object","required":["name","externalId","deliveryProviderUid"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderUid":{"$ref":"#/components/schemas/UID"}}}},"responses":{"DeliveryProviderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderResponseSchema"}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers":{"post":{"description":"Create a new delivery provider\n\nRequired permissions: DELIVERY_METHOD","operationId":"post-tenant-delivery-providers","requestBody":{"$ref":"#/components/requestBodies/DeliveryProviderCreateRequest"},"responses":{"201":{"$ref":"#/components/responses/DeliveryProviderResponse"}},"summary":"Create a new delivery provider","tags":["DeliveryProvider"]}}}}
```

## Get delivery provider details

> Get delivery provider details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryProvider","description":"DeliveryProvider"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"DeliveryProviderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderResponseSchema"}}}}},"schemas":{"DeliveryProviderResponseSchema":{"title":"DeliveryProviderResponseSchema","type":"object","required":["name","externalId","deliveryProviderUid"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}":{"get":{"description":"Get delivery provider details","operationId":"get-tenant-delivery-provider-details","responses":{"200":{"$ref":"#/components/responses/DeliveryProviderResponse"}},"summary":"Get delivery provider details","tags":["DeliveryProvider"]}}}}
```

## Update delivery provider details

> Update delivery provider details\
> \
> Required permissions: DELIVERY\_METHOD

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryProvider","description":"DeliveryProvider"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"DeliveryProviderUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderUpdateRequestSchema"}}}}},"schemas":{"DeliveryProviderUpdateRequestSchema":{"title":"DeliveryProviderUpdateRequestSchema","type":"object","properties":{"name":{"type":"string"},"externalId":{"type":"string"}},"description":""},"DeliveryProviderResponseSchema":{"title":"DeliveryProviderResponseSchema","type":"object","required":["name","externalId","deliveryProviderUid"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}},"responses":{"DeliveryProviderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderResponseSchema"}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}":{"put":{"operationId":"put-tenant-delivery-provider-details","description":"Update delivery provider details\n\nRequired permissions: DELIVERY_METHOD","requestBody":{"$ref":"#/components/requestBodies/DeliveryProviderUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/DeliveryProviderResponse"}},"summary":"Update delivery provider details","tags":["DeliveryProvider"]}}}}
```

## Delete an delivery provider

> Delete an delivery provider\
> \
> Required permissions: DELIVERY\_METHOD

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryProvider","description":"DeliveryProvider"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}":{"delete":{"description":"Delete an delivery provider\n\nRequired permissions: DELIVERY_METHOD","operationId":"delete-tenant-delivery-provider-details","responses":{"204":{"description":"No Content"}},"summary":"Delete an delivery provider","tags":["DeliveryProvider"]}}}}
```