# DeliveryMethod

DeliveryMethod

## List delivery methods for a delivery Provider

> List delivery methods for a delivery Provider

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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"},"deliveryProviderMethodQuery":{"description":"Query for the deliveryProviderMethod","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"},"DeliveryProviderMethodResponseSchema":{"title":"DeliveryProviderMethodResponseSchema","type":"object","required":["name","externalId","deliveryProviderMethodUid","freightProductUid","externalSystemMappings","dynamicOptions"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderMethodUid":{"$ref":"#/components/schemas/UID"},"freightProductUid":{"$ref":"#/components/schemas/OptionalUID"},"externalSystemMappings":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProviderMethodMappingResponseSchema"}},"dynamicOptions":{"type":"boolean","description":"This delivery method has dynamic options"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"DeliveryProviderMethodMappingResponseSchema":{"title":"DeliveryProviderMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["deliveryProviderMethodMappingUid"],"properties":{"deliveryProviderMethodMappingUid":{"$ref":"#/components/schemas/UID"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]},"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":{"DeliveryProviderMethodListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProviderMethodResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"]}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods":{"get":{"description":"List delivery methods for a delivery Provider","operationId":"get-tenant-delivery-provider-methods","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/deliveryProviderMethodQuery"}],"responses":{"200":{"$ref":"#/components/responses/DeliveryProviderMethodListResponse"}},"summary":"List delivery methods for a delivery Provider","tags":["DeliveryMethod"]}}}}
```

## Create a new delivery provider method

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

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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":{"DeliveryProviderMethodCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderMethodCreateRequestSchema"}}}}},"schemas":{"DeliveryProviderMethodCreateRequestSchema":{"title":"DeliveryProviderMethodCreateRequestSchema","type":"object","required":["name"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderMethodUid":{"$ref":"#/components/schemas/UID"},"freightProductUid":{"$ref":"#/components/schemas/OptionalUID"},"dynamicOptions":{"type":"boolean"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"DeliveryProviderMethodResponseSchema":{"title":"DeliveryProviderMethodResponseSchema","type":"object","required":["name","externalId","deliveryProviderMethodUid","freightProductUid","externalSystemMappings","dynamicOptions"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderMethodUid":{"$ref":"#/components/schemas/UID"},"freightProductUid":{"$ref":"#/components/schemas/OptionalUID"},"externalSystemMappings":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProviderMethodMappingResponseSchema"}},"dynamicOptions":{"type":"boolean","description":"This delivery method has dynamic options"}}},"DeliveryProviderMethodMappingResponseSchema":{"title":"DeliveryProviderMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["deliveryProviderMethodMappingUid"],"properties":{"deliveryProviderMethodMappingUid":{"$ref":"#/components/schemas/UID"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]}},"responses":{"DeliveryProviderMethodResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderMethodResponseSchema"}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods":{"post":{"description":"Create a new delivery provider method\n\nRequired permissions: DELIVERY_METHOD","operationId":"post-tenant-delivery-provider-methods","requestBody":{"$ref":"#/components/requestBodies/DeliveryProviderMethodCreateRequest"},"responses":{"201":{"$ref":"#/components/responses/DeliveryProviderMethodResponse"}},"summary":"Create a new delivery provider method","tags":["DeliveryMethod"]}}}}
```

## Get delivery provider method details

> Get delivery provider method details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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":{"DeliveryProviderMethodResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderMethodResponseSchema"}}}}},"schemas":{"DeliveryProviderMethodResponseSchema":{"title":"DeliveryProviderMethodResponseSchema","type":"object","required":["name","externalId","deliveryProviderMethodUid","freightProductUid","externalSystemMappings","dynamicOptions"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderMethodUid":{"$ref":"#/components/schemas/UID"},"freightProductUid":{"$ref":"#/components/schemas/OptionalUID"},"externalSystemMappings":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProviderMethodMappingResponseSchema"}},"dynamicOptions":{"type":"boolean","description":"This delivery method has dynamic options"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"DeliveryProviderMethodMappingResponseSchema":{"title":"DeliveryProviderMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["deliveryProviderMethodMappingUid"],"properties":{"deliveryProviderMethodMappingUid":{"$ref":"#/components/schemas/UID"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}":{"get":{"description":"Get delivery provider method details","operationId":"get-tenant-delivery-provider-method-details","responses":{"200":{"$ref":"#/components/responses/DeliveryProviderMethodResponse"}},"summary":"Get delivery provider method details","tags":["DeliveryMethod"]}}}}
```

## Update delivery provider method 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":"DeliveryMethod","description":"DeliveryMethod"}],"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":{"DeliveryProviderMethodUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderMethodUpdateRequestSchema"}}}}},"schemas":{"DeliveryProviderMethodUpdateRequestSchema":{"title":"DeliveryProviderMethodUpdateRequestSchema","type":"object","properties":{"name":{"type":"string"},"externalId":{"type":"string"},"freightProductUid":{"$ref":"#/components/schemas/OptionalUID"},"dynamicOptions":{"type":"boolean"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"DeliveryProviderMethodResponseSchema":{"title":"DeliveryProviderMethodResponseSchema","type":"object","required":["name","externalId","deliveryProviderMethodUid","freightProductUid","externalSystemMappings","dynamicOptions"],"properties":{"name":{"type":"string"},"externalId":{"type":"string"},"deliveryProviderMethodUid":{"$ref":"#/components/schemas/UID"},"freightProductUid":{"$ref":"#/components/schemas/OptionalUID"},"externalSystemMappings":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProviderMethodMappingResponseSchema"}},"dynamicOptions":{"type":"boolean","description":"This delivery method has dynamic options"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"DeliveryProviderMethodMappingResponseSchema":{"title":"DeliveryProviderMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["deliveryProviderMethodMappingUid"],"properties":{"deliveryProviderMethodMappingUid":{"$ref":"#/components/schemas/UID"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]}},"responses":{"DeliveryProviderMethodResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderMethodResponseSchema"}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}":{"put":{"operationId":"put-tenant-delivery-provider-method-details","description":"Update delivery provider details\n\nRequired permissions: DELIVERY_METHOD","requestBody":{"$ref":"#/components/requestBodies/DeliveryProviderMethodUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/DeliveryProviderMethodResponse"}},"summary":"Update delivery provider method details","tags":["DeliveryMethod"]}}}}
```

## Delete a delivery provider method

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

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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}/methods/{deliveryProviderMethodUid}":{"delete":{"description":"Delete an delivery provider method\n\nRequired permissions: DELIVERY_METHOD","operationId":"delete-tenant-delivery-provider-method-details","responses":{"204":{"description":"No Content"}},"summary":"Delete a delivery provider method","tags":["DeliveryMethod"]}}}}
```

## List all mappings for a delivery provider method

> List all mappings for a delivery provider method

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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":{"DeliveryProviderMethodMappingListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProviderMethodMappingResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"DeliveryProviderMethodMappingResponseSchema":{"title":"DeliveryProviderMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["deliveryProviderMethodMappingUid"],"properties":{"deliveryProviderMethodMappingUid":{"$ref":"#/components/schemas/UID"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]},"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"},"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"}},"parameters":{"systemCodeQuery":{"description":"Reference to a system code","explode":false,"in":"query","name":"systemCode","schema":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"style":"form"},"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"}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings":{"get":{"description":"List all mappings for a delivery provider method","operationId":"get-delivery-provider-method-mappings","responses":{"200":{"$ref":"#/components/responses/DeliveryProviderMethodMappingListResponse"}},"summary":"List all mappings for a delivery provider method","parameters":[{"$ref":"#/components/parameters/systemCodeQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"tags":["DeliveryMethod"]}}}}
```

## Create delivery provider method mapping

> Create delivery provider method mapping\
> \
> Required permissions: DELIVERY\_METHOD

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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":{"DeliveryProviderMethodMappingCreateRequest":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"deliveryProviderMethodMappingUid":{"type":"string"}}},{"$ref":"#/components/schemas/GeneralMappingCreateRequestSchema"}]}}}}},"schemas":{"GeneralMappingCreateRequestSchema":{"title":"GeneralMappingCreateRequestSchema","type":"object","required":["externalId","systemCode"],"properties":{"externalId":{"type":"string"},"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]},"DeliveryProviderMethodMappingResponseSchema":{"title":"DeliveryProviderMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["deliveryProviderMethodMappingUid"],"properties":{"deliveryProviderMethodMappingUid":{"$ref":"#/components/schemas/UID"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}},"responses":{"DeliveryProviderMethodMappingResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderMethodMappingResponseSchema"}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings":{"post":{"description":"Create delivery provider method mapping\n\nRequired permissions: DELIVERY_METHOD","operationId":"post-delivery-provider-method-mapping","requestBody":{"$ref":"#/components/requestBodies/DeliveryProviderMethodMappingCreateRequest"},"responses":{"200":{"$ref":"#/components/responses/DeliveryProviderMethodMappingResponse"}},"summary":"Create delivery provider method mapping","tags":["DeliveryMethod"]}}}}
```

## Update a mapping for a delivery provider method

> Update a mapping for a delivery provider method

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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":{"DeliveryProviderMethodMappingResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProviderMethodMappingResponseSchema"}}}}},"schemas":{"DeliveryProviderMethodMappingResponseSchema":{"title":"DeliveryProviderMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["deliveryProviderMethodMappingUid"],"properties":{"deliveryProviderMethodMappingUid":{"$ref":"#/components/schemas/UID"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"GeneralMappingUpdateRequestSchema":{"title":"GeneralMappingUpdateRequestSchema","type":"object","required":["externalId"],"properties":{"externalId":{"type":"string"}}}},"requestBodies":{"DeliveryProviderMethodMappingUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMappingUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings/{deliveryProviderMethodMappingUid}":{"put":{"description":"Update a mapping for a delivery provider method","operationId":"put-delivery-provider-method-mapping","responses":{"200":{"$ref":"#/components/responses/DeliveryProviderMethodMappingResponse"}},"summary":"Update a mapping for a delivery provider method","requestBody":{"$ref":"#/components/requestBodies/DeliveryProviderMethodMappingUpdateRequest"},"tags":["DeliveryMethod"]}}}}
```

## Delete a delivery provider method mapping

> Delete a delivery provider method mapping

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"}],"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":{"DeliveryProviderMethodMappingCreateRequest":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"deliveryProviderMethodMappingUid":{"type":"string"}}},{"$ref":"#/components/schemas/GeneralMappingCreateRequestSchema"}]}}}}},"schemas":{"GeneralMappingCreateRequestSchema":{"title":"GeneralMappingCreateRequestSchema","type":"object","required":["externalId","systemCode"],"properties":{"externalId":{"type":"string"},"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]}}},"paths":{"/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings/{deliveryProviderMethodMappingUid}":{"delete":{"description":"Delete a delivery provider method mapping","operationId":"delete-delivery-provider-method-mapping","requestBody":{"$ref":"#/components/requestBodies/DeliveryProviderMethodMappingCreateRequest"},"responses":{"204":{"description":"No Content"}},"summary":"Delete a delivery provider method mapping","tags":["DeliveryMethod"]}}}}
```

## List Profrakt delivery methods

> List Prorakt delivery methods

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"DeliveryMethod","description":"DeliveryMethod"},{"name":"Profrakt","description":"Profrakt"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"responses":{"ProfraktDeliveryMethodsListResponse":{"description":"Profrakt Delivery Methods List Response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProfraktDeliveryMethodsListSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"ProfraktDeliveryMethodsListSchema":{"title":"ProfraktDeliveryMethodsListSchema","type":"object","required":["profraktIdentifier","name"],"properties":{"profraktIdentifier":{"type":"string"},"name":{"type":"string"}}},"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"},"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"}},"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"}}},"paths":{"/tenants/{tenantUid}/profrakt-delivery-methods":{"get":{"summary":"List Profrakt delivery methods","tags":["DeliveryMethod","Profrakt"],"responses":{"200":{"$ref":"#/components/responses/ProfraktDeliveryMethodsListResponse"}},"operationId":"list-tenant-tenantUid-profrakt-delivery-methods","description":"List Prorakt delivery methods","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}]}}}}
```