POST /carrier-pickups.json

POST /carrier-pickups.json
application/json

Body Required

Responses

POST /carrier-pickups.json
curl \
 --request POST 'http://api.example.com/v1/carrier-pickups.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"carrier":"string","dropshipProviderId":42,"externalId":"string","fromAddressLineOne":"string","fromAddressLineTwo":"string","fromCity":"string","fromCountry":"string","fromEmail":"string","fromName":"string","fromPhone":"string","fromState":"string","fromZip":"string","payload":{},"pickupAt":"2025-05-04T09:42:00Z","response":{},"source":"string","status":"string","toCountry":"string"}'
Request examples
{
  "carrier": "string",
  "dropshipProviderId": 42,
  "externalId": "string",
  "fromAddressLineOne": "string",
  "fromAddressLineTwo": "string",
  "fromCity": "string",
  "fromCountry": "string",
  "fromEmail": "string",
  "fromName": "string",
  "fromPhone": "string",
  "fromState": "string",
  "fromZip": "string",
  "payload": {},
  "pickupAt": "2025-05-04T09:42:00Z",
  "response": {},
  "source": "string",
  "status": "string",
  "toCountry": "string"
}
Response examples (200)
{
  "carrier": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipProviderId": 42,
  "externalId": "string",
  "fromAddressLineOne": "string",
  "fromAddressLineTwo": "string",
  "fromCity": "string",
  "fromCountry": "string",
  "fromEmail": "string",
  "fromName": "string",
  "fromPhone": "string",
  "fromState": "string",
  "fromZip": "string",
  "id": 42,
  "payload": {},
  "pickupAt": "2025-05-04T09:42:00Z",
  "response": {},
  "source": "string",
  "status": "string",
  "toCountry": "string",
  "updatedAt": "2025-05-04T09:42:00Z"
}