Execute a delivery

PUT

/api/tenant/{tenantId}/Deliveries/{id}/execute

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Deliveries/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/execute"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"fields\": { \"additionalProperty\": { \"value\": \"example\", \"valueType\": \"example\" } }, \"accessibility\": \"example\", \"deliveryCredentialId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"token\": \"example\", \"amount\": 1, \"currency\": \"example\", \"email\": \"example\", \"name\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Deliveries/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/execute';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"fields":{"additionalProperty":{"value":"example","valueType":"example"}},"accessibility":"example","deliveryCredentialId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","token":"example","amount":1,"currency":"example","email":"example","name":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Deliveries/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "deliveryCredentialId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "token": "example", "amount": 1, "currency": "example", "email": "example", "name": "example" }'

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

tenantId

required

string format: uuid

Your tenant id.

Request Body

application/json

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

deliveryCredentialId

string format: uuid

nullable

token

string

nullable

amount

number format: double

currency

string

nullable

email

string

nullable

name

string

nullable

Example ^generated

{
  "fields": {
    "additionalProperty": {
      "value": "example",
      "valueType": "example"
    }
  },
  "accessibility": "example",
  "deliveryCredentialId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "token": "example",
  "amount": 1,
  "currency": "example",
  "email": "example",
  "name": "example"
}

Responses

200

application/json

object

fields

object

key

additional properties

string

data

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

relations

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

name

string

nullable

entityId

required

string format: uuid

entityType

required

string

>= 1 characters

relationType

required

string

>= 1 characters

tenantId

string format: uuid

nullable

resourceGroupId

string format: uuid

nullable

creatorId

string format: uuid

nullable

createdDate

string format: date-time

nullable

version

integer format: int32

nullable

lastModified

string format: date-time

nullable

deliveryOptionId

string format: uuid

orderId

string format: uuid

nullable

deliveryNumber

integer format: int32

name

string

nullable

description

string

nullable

deliveryType

string

nullable

status

string

nullable

buyer

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

organizationId

string format: uuid

nullable

userId

string format: uuid

nullable

siteId

string format: uuid

nullable

customerType

string

nullable

identityNumber

string

nullable

organizationName

string

nullable

firstName

string

nullable

lastName

string

nullable

email

string

nullable

phoneNumber

string

nullable

deliveryAddress

object

coAddress

string

nullable

state

string

nullable

country

string

nullable

name

string

nullable

firstName

string

nullable

lastName

string

nullable

street

string

nullable

postalCode

string

nullable

city

string

nullable

billingAddress

object

coAddress

string

nullable

state

string

nullable

country

string

nullable

name

string

nullable

firstName

string

nullable

lastName

string

nullable

street

string

nullable

postalCode

string

nullable

city

string

nullable

useDeliveryAddress

boolean

seller

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

organizationId

string format: uuid

nullable

userId

string format: uuid

nullable

siteId

string format: uuid

nullable

items

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

orderId

string format: uuid

nullable

orderItemId

string format: uuid

nullable

sku

string

nullable

name

string

nullable

description

string

nullable

unitNetPrice

number format: double

unitGrossPrice

number format: double

quantity

number format: double

netAmount

number format: double

vatRate

integer format: int32

nullable

grossAmount

number format: double

netAmount

number format: double

grossAmount

number format: double

currency

string

nullable

dueDate

string format: date-time

nullable

events

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

userId

string format: uuid

eventType

string

nullable

status

string

nullable

clientIpAddress

string

nullable

deliveryIntegrationStatus

string

nullable

message

string

nullable

urls

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

cancel

string

nullable

terms

string

nullable

checkout

string

nullable

confirmation

string

nullable

push

string

nullable

addressUpdate

string

nullable

cancellationTerms

string

nullable

countryChange

string

nullable

notification

string

nullable

shippingOptionUpdate

string

nullable

validation

string

nullable

country

string

nullable

deliveryIntegration

string

nullable

deliveryIntegrationStatus

string

nullable

deliveryReference

string

nullable

customerReference

string

nullable

requiresCompletedPayment

boolean

Example ^generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "deliveryOptionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "orderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "deliveryNumber": 1,
    "name": "example",
    "description": "example",
    "deliveryType": "example",
    "status": "example",
    "buyer": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "customerType": "example",
      "identityNumber": "example",
      "organizationName": "example",
      "firstName": "example",
      "lastName": "example",
      "email": "example",
      "phoneNumber": "example",
      "deliveryAddress": {
        "coAddress": "example",
        "state": "example",
        "country": "example",
        "name": "example",
        "firstName": "example",
        "lastName": "example",
        "street": "example",
        "postalCode": "example",
        "city": "example"
      },
      "billingAddress": {
        "coAddress": "example",
        "state": "example",
        "country": "example",
        "name": "example",
        "firstName": "example",
        "lastName": "example",
        "street": "example",
        "postalCode": "example",
        "city": "example"
      },
      "useDeliveryAddress": true
    },
    "seller": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    },
    "items": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "orderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "orderItemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "sku": "example",
        "name": "example",
        "description": "example",
        "unitNetPrice": 1,
        "unitGrossPrice": 1,
        "quantity": 1,
        "netAmount": 1,
        "vatRate": 1,
        "grossAmount": 1
      }
    ],
    "netAmount": 1,
    "grossAmount": 1,
    "currency": "example",
    "dueDate": "2026-04-15T12:00:00Z",
    "events": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "eventType": "example",
        "status": "example",
        "clientIpAddress": "example",
        "deliveryIntegrationStatus": "example",
        "message": "example"
      }
    ],
    "urls": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "cancel": "example",
      "terms": "example",
      "checkout": "example",
      "confirmation": "example",
      "push": "example",
      "addressUpdate": "example",
      "cancellationTerms": "example",
      "countryChange": "example",
      "notification": "example",
      "shippingOptionUpdate": "example",
      "validation": "example"
    },
    "country": "example",
    "deliveryIntegration": "example",
    "deliveryIntegrationStatus": "example",
    "deliveryReference": "example",
    "customerReference": "example",
    "requiresCompletedPayment": true
  }
}

204

No Content: done, with no item to return.

401

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

application/json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Not found: no such item in the tenant.

application/problem+json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Conflict: the item kept changing under concurrent writes; read it again and retry.

application/problem+json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

422

Unprocessable: the body or the change is invalid. The errors are keyed by member.

application/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object

errors

object

key

additional properties

Array<string>

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "status": 1,
  "title": "example",
  "type": "example"
}

Execute a delivery

Authorizations

Parameters

Path Parameters

Request Body

Example generated

Responses

200

Example generated

204

401

403

Example generated

404

Example generated

409

Example generated

422

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated