---
title: "Assign"
method: POST
path: "/assign"
---

# Assign

`POST /assign`

## Request

- Base URL: `https://api.shipday.com/on-demand`
- URL: `https://api.shipday.com/on-demand/assign`
- Auth: API key in header `Authorization`

Assign to a specific 3rd party delivery service provider. Usually, after getting an estimate.

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Request body

- object
  - `name` string, required: Name of the 3rd party service provider
  - `orderId` integer, required: Order id of the order to be assigned
  - `tip` number, double: Tip amount for the order
  - `estimateReference` string: Reference id of the estimate
  - `contactlessDelivery` boolean: Boolean value indicating contactless delivery or not
  - `podType` '"PHOTO"' | '"SIGNATURE"' | '"PIN"' | '"NONE"': Enum values ("PHOTO", "SIGNATURE", "PIN", "NONE") indicating proof of delivery type
  - `podTypes` string[]: If multiple POD types are applicable, then it can be sent in this property as an array of enum POD types like ["PHOTO", "PIN"]

## Response `200`

200

- object
  - `id` integer
  - `orderId` integer
  - `companyId` integer
  - `adminId` integer
  - `thirdPartyName` string
  - `referenceId` string
  - `referenceTag` string
  - `thirdPartyFee` number
  - `shipdayCharge` number
  - `totalBillableAmount` number
  - `charged` boolean
  - `timestamp` string
  - `insertedAt` integer
  - `data` string
  - `trackingUrl` string
  - `driverName` string
  - `driverPhone` string
  - `driverLat` number
  - `driverLng` number
  - `driverImageUrl` string
  - `driverVehicleDescription` unknown
  - `tip` number
  - `processingFee` number
  - `status` string
  - `billable` boolean

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/shipday/apis/on-demand.md) - [All operations](https://skmtc.dev/shipday/apis/on-demand/llms.txt) - [OpenAPI document](https://skmtc.dev/shipday/apis/on-demand/revisions/04d257f7ea79?raw)