Skip to main content
POST
/
orgs
/
{orgId}
/
shipments
/
{shipmentId}
/
create-return
Creates and sends a return shipment with swapped sender/receiver
curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}/create-return \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "reference": "<string>",
  "senderAddressId": "<string>",
  "parties": [
    {
      "type": "sender",
      "name": "<string>",
      "address1": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "attributes": [],
      "attention": "<string>",
      "address2": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>"
    }
  ],
  "type": "outbound",
  "carrierSettings": {
    "carrierId": "<string>",
    "productId": "<string>",
    "services": [
      "<string>"
    ],
    "additionalParameters": {}
  },
  "parcels": [
    {
      "weight": 1,
      "weightUnit": "kg",
      "dimensions": {
        "length": 1,
        "width": 1,
        "height": 1
      },
      "orderLines": [
        {
          "sku": "<string>",
          "quantity": 4503599627370496,
          "id": "<string>",
          "description": "<string>",
          "unitPrice": 1,
          "currency": "<string>",
          "vatPercent": 1,
          "location": "<string>",
          "countryOfOrigin": "<string>",
          "tarrifNumber": "<string>"
        }
      ],
      "id": "<string>"
    }
  ],
  "termOfTrade": "DAP",
  "status": "draft",
  "orgId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "servicePointId": "<string>",
  "pickupDetails": {
    "date": "<string>",
    "from": "<string>",
    "to": "<string>",
    "instruction": "<string>"
  },
  "documents": [
    {
      "id": "<string>",
      "shipmentId": "<string>",
      "documentType": "label",
      "format": "pdf",
      "content": "<string>",
      "size": "A4",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "tracking": {
    "url": "<string>",
    "number": "<string>"
  },
  "orderId": "<string>",
  "shippingRuleId": "<string>",
  "shippingRule": {
    "id": "<string>",
    "name": "<string>",
    "carrierId": "<string>",
    "productId": "<string>",
    "services": [
      "<string>"
    ],
    "senderAddressId": "<string>",
    "returnShippingRuleId": "<string>",
    "autoCreateReturnShipment": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.zippendo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

​
orgId
string
required

Organization ID

​
shipmentId
string
required

Shipment ID

Response

Default Response

​
id
string
required
​
reference
string
required
​
senderAddressId
string
required
​
parties
object[]
required
​
type
enum<string>
required
Available options:
outbound,
inbound
​
carrierSettings
object
required
​
parcels
object[]
required
​
termOfTrade
string
default:DAP
required
​
status
enum<string>
required
Available options:
draft,
pending,
processing,
dispatched,
partly_dispatched,
error,
cancelled,
on_hold
​
orgId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
servicePointId
string | null
​
pickupDetails
object
​
documents
object[]
​
tracking
object
​
orderId
string | null
​
shippingRuleId
string | null
​
shippingRule
object