Update One Stop - Upwell Developer Docs

Update One Stop

curl --request PUT \
  --url https://api.upwell.com/api/rest/stops/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "addressId": "<string>",
    "appointmentEnd": "2023-11-07T05:31:56Z",
    "appointmentStart": "2023-11-07T05:31:56Z",
    "appointmentTimezone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "pieceCount": 123,
    "referenceNumbers": "<unknown>",
    "sequenceNumber": 123,
    "shipmentId": "<string>",
    "stopType": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "weightAmount": "<unknown>",
    "weightUnit": "<string>"
  }
}
'

import requests

url = "https://api.upwell.com/api/rest/stops/{id}"

payload = {
    "id": "<string>",
    "input": {
        "addressId": "<string>",
        "appointmentEnd": "2023-11-07T05:31:56Z",
        "appointmentStart": "2023-11-07T05:31:56Z",
        "appointmentTimezone": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": "<string>",
        "name": "<string>",
        "notes": "<string>",
        "pieceCount": 123,
        "referenceNumbers": "<unknown>",
        "sequenceNumber": 123,
        "shipmentId": "<string>",
        "stopType": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "weightAmount": "<unknown>",
        "weightUnit": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    input: {
      addressId: '<string>',
      appointmentEnd: '2023-11-07T05:31:56Z',
      appointmentStart: '2023-11-07T05:31:56Z',
      appointmentTimezone: '<string>',
      createdAt: '2023-11-07T05:31:56Z',
      id: '<string>',
      metadata: '<string>',
      name: '<string>',
      notes: '<string>',
      pieceCount: 123,
      referenceNumbers: '<unknown>',
      sequenceNumber: 123,
      shipmentId: '<string>',
      stopType: '<string>',
      updatedAt: '2023-11-07T05:31:56Z',
      weightAmount: '<unknown>',
      weightUnit: '<string>'
    }
  })
};

fetch('https://api.upwell.com/api/rest/stops/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upwell.com/api/rest/stops/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'input' => [
        'addressId' => '<string>',
        'appointmentEnd' => '2023-11-07T05:31:56Z',
        'appointmentStart' => '2023-11-07T05:31:56Z',
        'appointmentTimezone' => '<string>',
        'createdAt' => '2023-11-07T05:31:56Z',
        'id' => '<string>',
        'metadata' => '<string>',
        'name' => '<string>',
        'notes' => '<string>',
        'pieceCount' => 123,
        'referenceNumbers' => '<unknown>',
        'sequenceNumber' => 123,
        'shipmentId' => '<string>',
        'stopType' => '<string>',
        'updatedAt' => '2023-11-07T05:31:56Z',
        'weightAmount' => '<unknown>',
        'weightUnit' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upwell.com/api/rest/stops/{id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"addressId\": \"<string>\",\n    \"appointmentEnd\": \"2023-11-07T05:31:56Z\",\n    \"appointmentStart\": \"2023-11-07T05:31:56Z\",\n    \"appointmentTimezone\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"pieceCount\": 123,\n    \"referenceNumbers\": \"<unknown>\",\n    \"sequenceNumber\": 123,\n    \"shipmentId\": \"<string>\",\n    \"stopType\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"weightAmount\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.upwell.com/api/rest/stops/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"addressId\": \"<string>\",\n    \"appointmentEnd\": \"2023-11-07T05:31:56Z\",\n    \"appointmentStart\": \"2023-11-07T05:31:56Z\",\n    \"appointmentTimezone\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"pieceCount\": 123,\n    \"referenceNumbers\": \"<unknown>\",\n    \"sequenceNumber\": 123,\n    \"shipmentId\": \"<string>\",\n    \"stopType\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"weightAmount\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upwell.com/api/rest/stops/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"addressId\": \"<string>\",\n    \"appointmentEnd\": \"2023-11-07T05:31:56Z\",\n    \"appointmentStart\": \"2023-11-07T05:31:56Z\",\n    \"appointmentTimezone\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"pieceCount\": 123,\n    \"referenceNumbers\": \"<unknown>\",\n    \"sequenceNumber\": 123,\n    \"shipmentId\": \"<string>\",\n    \"stopType\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"weightAmount\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "updateStop": {
    "address": {
      "city": "<string>",
      "id": "<string>",
      "name": "<string>",
      "stateOrProvince": "<string>",
      "streetLine1": "<string>",
      "streetLine2": "<string>",
      "streetLine3": "<string>",
      "zipOrPostalCode": "<string>"
    },
    "addressId": "<string>",
    "appointmentEnd": "2023-11-07T05:31:56Z",
    "appointmentStart": "2023-11-07T05:31:56Z",
    "appointmentTimezone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "pieceCount": 123,
    "referenceNumbers": "<unknown>",
    "sequenceNumber": 123,
    "shipmentId": "<string>",
    "stopType": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "weightAmount": "<unknown>",
    "weightUnit": "<string>"
  }
}

PUT

api

rest

stops

{id}

Update One Stop

curl --request PUT \
  --url https://api.upwell.com/api/rest/stops/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "addressId": "<string>",
    "appointmentEnd": "2023-11-07T05:31:56Z",
    "appointmentStart": "2023-11-07T05:31:56Z",
    "appointmentTimezone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "pieceCount": 123,
    "referenceNumbers": "<unknown>",
    "sequenceNumber": 123,
    "shipmentId": "<string>",
    "stopType": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "weightAmount": "<unknown>",
    "weightUnit": "<string>"
  }
}
'

import requests

url = "https://api.upwell.com/api/rest/stops/{id}"

payload = {
    "id": "<string>",
    "input": {
        "addressId": "<string>",
        "appointmentEnd": "2023-11-07T05:31:56Z",
        "appointmentStart": "2023-11-07T05:31:56Z",
        "appointmentTimezone": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": "<string>",
        "name": "<string>",
        "notes": "<string>",
        "pieceCount": 123,
        "referenceNumbers": "<unknown>",
        "sequenceNumber": 123,
        "shipmentId": "<string>",
        "stopType": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "weightAmount": "<unknown>",
        "weightUnit": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    input: {
      addressId: '<string>',
      appointmentEnd: '2023-11-07T05:31:56Z',
      appointmentStart: '2023-11-07T05:31:56Z',
      appointmentTimezone: '<string>',
      createdAt: '2023-11-07T05:31:56Z',
      id: '<string>',
      metadata: '<string>',
      name: '<string>',
      notes: '<string>',
      pieceCount: 123,
      referenceNumbers: '<unknown>',
      sequenceNumber: 123,
      shipmentId: '<string>',
      stopType: '<string>',
      updatedAt: '2023-11-07T05:31:56Z',
      weightAmount: '<unknown>',
      weightUnit: '<string>'
    }
  })
};

fetch('https://api.upwell.com/api/rest/stops/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upwell.com/api/rest/stops/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'input' => [
        'addressId' => '<string>',
        'appointmentEnd' => '2023-11-07T05:31:56Z',
        'appointmentStart' => '2023-11-07T05:31:56Z',
        'appointmentTimezone' => '<string>',
        'createdAt' => '2023-11-07T05:31:56Z',
        'id' => '<string>',
        'metadata' => '<string>',
        'name' => '<string>',
        'notes' => '<string>',
        'pieceCount' => 123,
        'referenceNumbers' => '<unknown>',
        'sequenceNumber' => 123,
        'shipmentId' => '<string>',
        'stopType' => '<string>',
        'updatedAt' => '2023-11-07T05:31:56Z',
        'weightAmount' => '<unknown>',
        'weightUnit' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upwell.com/api/rest/stops/{id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"addressId\": \"<string>\",\n    \"appointmentEnd\": \"2023-11-07T05:31:56Z\",\n    \"appointmentStart\": \"2023-11-07T05:31:56Z\",\n    \"appointmentTimezone\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"pieceCount\": 123,\n    \"referenceNumbers\": \"<unknown>\",\n    \"sequenceNumber\": 123,\n    \"shipmentId\": \"<string>\",\n    \"stopType\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"weightAmount\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.upwell.com/api/rest/stops/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"addressId\": \"<string>\",\n    \"appointmentEnd\": \"2023-11-07T05:31:56Z\",\n    \"appointmentStart\": \"2023-11-07T05:31:56Z\",\n    \"appointmentTimezone\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"pieceCount\": 123,\n    \"referenceNumbers\": \"<unknown>\",\n    \"sequenceNumber\": 123,\n    \"shipmentId\": \"<string>\",\n    \"stopType\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"weightAmount\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upwell.com/api/rest/stops/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"addressId\": \"<string>\",\n    \"appointmentEnd\": \"2023-11-07T05:31:56Z\",\n    \"appointmentStart\": \"2023-11-07T05:31:56Z\",\n    \"appointmentTimezone\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"pieceCount\": 123,\n    \"referenceNumbers\": \"<unknown>\",\n    \"sequenceNumber\": 123,\n    \"shipmentId\": \"<string>\",\n    \"stopType\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"weightAmount\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "updateStop": {
    "address": {
      "city": "<string>",
      "id": "<string>",
      "name": "<string>",
      "stateOrProvince": "<string>",
      "streetLine1": "<string>",
      "streetLine2": "<string>",
      "streetLine3": "<string>",
      "zipOrPostalCode": "<string>"
    },
    "addressId": "<string>",
    "appointmentEnd": "2023-11-07T05:31:56Z",
    "appointmentStart": "2023-11-07T05:31:56Z",
    "appointmentTimezone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "pieceCount": 123,
    "referenceNumbers": "<unknown>",
    "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

Path Parameters

string

required

"id" is required (enter it either in parameters or request body)

Body

application/json

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

string

input

StopsSetInput · object

input type for updating data in table "stops"

Show child attributes

Response

200 - application/json

Responses for PUT /api/rest/stops/{id}

updateStop

Stops · object | null

columns and relationships of "stops"

Show child attributes

⌘I