POST /carrier-pickups.json
Body Required
-
Carrier
-
Dropship provider
-
externalId string | null
External
-
fromAddressLineOne string | null
From address line one
-
fromAddressLineTwo string | null
From address line two
-
fromCity string | null
From city
-
fromCountry string | null
From country
-
fromEmail string | null
From email
-
fromName string | null
From name
-
fromPhone string | null
From phone
-
fromState string | null
From state
-
fromZip string | null
From zip
-
Pickup at
-
Source
-
Status
-
toCountry string | null
To country
POST
/carrier-pickups.json
curl \
-X POST http://api.example.com/v1/carrier-pickups.json \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"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":"2024-05-04T09:42:00+00:00","response":{},"source":"string","status":"string","toCountry":"string"}'
Request example
{
"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": "2024-05-04T09:42:00+00:00",
"response": {},
"source": "string",
"status": "string",
"toCountry": "string"
}
Response examples (200)
{
"carrier": "string",
"createdAt": "2024-05-04T09:42:00+00:00",
"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": "2024-05-04T09:42:00+00:00",
"response": {},
"source": "string",
"status": "string",
"toCountry": "string",
"updatedAt": "2024-05-04T09:42:00+00:00"
}