Skip to main content
POST
/
api
/
rest
/
stops
Create One Stop
curl --request POST \
  --url https://api.upwell.com/api/rest/stops \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "address": {},
    "addressId": "<string>",
    "metadata": "<string>",
    "name": "<string>",
    "pieceCount": 123,
    "sequenceNumber": 123,
    "shipmentId": "<string>",
    "stopType": "<string>",
    "type": "CONSOLIDATION",
    "weightAmount": "<unknown>",
    "weightUnit": "<string>"
  }
}
'
{
  "createStop": {
    "address": {
      "city": "<string>",
      "country": "AD",
      "id": "<string>",
      "name": "<string>",
      "stateOrProvince": "<string>",
      "streetLine1": "<string>",
      "streetLine2": "<string>",
      "streetLine3": "<string>",
      "zipOrPostalCode": "<string>"
    },
    "addressId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": "<string>",
    "name": "<string>",
    "pieceCount": 123,
    "sequenceNumber": 123,
    "shipmentId": "<string>",
    "stopType": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "weightAmount": "<unknown>",
    "weightUnit": "<string>"
  }
}

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Body

application/json

Query parameters can also be provided in the request body as a JSON object

input
StopsInsertInput Ā· object

input type for inserting data into table "stops"

Response

200 - application/json

Responses for POST /api/rest/stops

createStop
Stops Ā· object

columns and relationships of "stops"