Create a new delivery provider method

Create a new delivery provider method

Required permissions: DELIVERY_METHOD

post

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

Authorizations

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

namestringRequired

externalIdstringOptional

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

freightProductUidstringOptionalPattern: ^[A-Za-z0-9-_]*

dynamicOptionsbooleanOptional

allowMultipleWarehousesbooleanOptional

When true, the lines on one delivery may ship from different warehouses. When false, every line on the delivery must use the same warehouse.

warehouseUidsstring[]Optional

The warehouses this delivery method may ship from. An empty list means every warehouse the store has SHIP access to is available.

Responses

201

Example response

application/json

namestringRequired

externalIdstringRequired

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

freightProductUidstringRequiredPattern: ^[A-Za-z0-9-_]*

dynamicOptionsbooleanRequired

This delivery method has dynamic options

allowMultipleWarehousesbooleanRequired

When true, the lines on one delivery may ship from different warehouses. When false, every line on the delivery must use the same warehouse.

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

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

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderMethodUid": "text",
  "freightProductUid": "text",
  "dynamicOptions": true,
  "allowMultipleWarehouses": true,
  "warehouseUids": [
    "text"
  ]
}

201

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderMethodUid": "text",
  "freightProductUid": "text",
  "externalSystemMappings": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "deliveryProviderMethodMappingUid": "text"
    }
  ],
  "dynamicOptions": true,
  "allowMultipleWarehouses": true,
  "warehouses": [
    {
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text"
    }
  ]
}