Get delivery provider method details

Get delivery provider method details

get

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

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.

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

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

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