TypeScript
import { Configuration, OrdersApi } from "@zippendo/sdk"
const api = new OrdersApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.deleteOrder({ orgId: "...", orderId: "..." })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.OrdersApi(client).delete_order("...", "...")<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\OrdersApi(new GuzzleHttp\Client(), $config);
$result = $api->deleteOrder("...", "...");client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.OrdersAPI.DeleteOrder(ctx, "...", "...").Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::OrdersApi.new.delete_order("...", "...")curl --request DELETE \
--url https://api.zippendo.com/orgs/{orgId}/orders/{orderId} \
--header 'Authorization: Bearer <token>'const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zippendo.com/orgs/{orgId}/orders/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.delete("https://api.zippendo.com/orgs/{orgId}/orders/{orderId}")
.header("Authorization", "Bearer <token>")
.asString();{
"message": "Operation completed successfully"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}Orders
Delete order
Deletes an order. Fails if the order has associated shipments.
DELETE
/
orgs
/
{orgId}
/
orders
/
{orderId}
TypeScript
import { Configuration, OrdersApi } from "@zippendo/sdk"
const api = new OrdersApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.deleteOrder({ orgId: "...", orderId: "..." })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.OrdersApi(client).delete_order("...", "...")<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\OrdersApi(new GuzzleHttp\Client(), $config);
$result = $api->deleteOrder("...", "...");client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.OrdersAPI.DeleteOrder(ctx, "...", "...").Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::OrdersApi.new.delete_order("...", "...")curl --request DELETE \
--url https://api.zippendo.com/orgs/{orgId}/orders/{orderId} \
--header 'Authorization: Bearer <token>'const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zippendo.com/orgs/{orgId}/orders/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.delete("https://api.zippendo.com/orgs/{orgId}/orders/{orderId}")
.header("Authorization", "Bearer <token>")
.asString();{
"message": "Operation completed successfully"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}Authorizations
JWT access token or API token (prefixed with zipp_)
Path Parameters
Organization ID.
Example:
"clz9k2f0a0000abcd0000zzzz"
Order ID.
Example:
"clz9k2f0a0003abcd9012mnop"
Response
Default Response
Result message
Example:
"Operation completed successfully"
Was this page helpful?
⌘I