Update delivery provider method details

Update delivery provider details

Required permissions: DELIVERY_METHOD

put

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

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-_]+

deliveryProviderMethodUidstringRequired

Reference to a delivery provider method.

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

Body

namestringOptional

externalIdstringOptional

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

Replaces the delivery method's warehouse allow-list. Omit the field to leave the list unchanged; send an empty array to clear it, which makes every warehouse the store has SHIP access to available.

Responses

200

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.

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

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

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

200

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"
    }
  ]
}