> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spojit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shippit

> Shipping quotes, order management, tracking, labels, and carrier booking.

The Shippit connector lets your workflows get shipping quotes, create and manage orders, track shipments, generate labels, and book carriers through Shippit's REST API.

<Note>
  For the full API reference, see the [Shippit API documentation](https://developer.shippit.com/).
</Note>

<Snippet file="connection-note.mdx" />

## Connection setup

<Steps>
  <Step title="Get your API secret">
    Log in to [Shippit](https://app.shippit.com) and go to **Settings > Integrations**. Create or copy your API secret.
  </Step>

  <Step title="Add the connection in Spojit">
    Go to **Connections** in Spojit, click **Add Connection**, select **Shippit**, and enter:

    * **API Secret**: Your Shippit API secret
    * **Environment** (optional): Choose `production` (default) or `staging` for testing
  </Step>
</Steps>

## Tools

### Quotes

<AccordionGroup>
  <Accordion title="get-quotes: Get shipping rate quotes">
    <ParamField body="quote" type="object" required>
      Quote request with `dropoff_postcode`, `dropoff_state`, `dropoff_suburb`, and `parcel_attributes`.
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "quote": {
        "dropoff_postcode": "2000",
        "dropoff_state": "NSW",
        "dropoff_suburb": "Sydney",
        "parcel_attributes": [
          {
            "qty": 1,
            "weight": 1
          }
        ]
      }
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": [
        {
          "courier_type": "CouriersPlease",
          "quotes": [
            {
              "price": 20.4,
              "estimated_transit_time": "3 business days"
            }
          ],
          "service_level": "standard",
          "success": true
        },
        {
          "courier_type": "eParcelExpress",
          "quotes": [
            {
              "price": 30.4,
              "estimated_transit_time": "1 business day"
            }
          ],
          "service_level": "express",
          "success": true
        },
        {
          "courier_type": "Priority",
          "quotes": [
            {
              "delivery_date": "2014-09-18T00:00:00.000Z",
              "delivery_window": "07:00-10:00",
              "delivery_window_desc": "7AM-10AM",
              "price": 24.24,
              "courier_type": "Bonds"
            },
            {
              "delivery_date": "2014-09-18T00:00:00.000Z",
              "delivery_window": "10:00-13:00",
              "delivery_window_desc": "10AM-1PM",
              "price": 24.24,
              "courier_type": "AlliedExpressP2P"
            }
          ],
          "service_level": "priority",
          "success": true
        },
        {
          "courier_type": "DoorDashOndemand",
          "quotes": [
            {
              "price": 10.99,
              "estimated_delivery_time": "2023-10-03T16:21:57.000+11:00"
            }
          ],
          "service_level": "on_demand",
          "success": true
        }
      ],
      "count": 4
    }
    ```
  </Accordion>
</AccordionGroup>

### Orders

<AccordionGroup>
  <Accordion title="create-order: Create a shipping order">
    <ParamField body="order" type="object" required>
      Order object with `courier_type`, `delivery_address`, `parcels`, `user_attributes`, and `items`.
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "order": {
        "courier_type": "standard",
        "delivery_address": "1 Union Street",
        "delivery_postcode": "2009",
        "delivery_state": "NSW",
        "delivery_suburb": "Pyrmont",
        "authority_to_leave": "Yes",
        "parcel_attributes": [
          {
            "qty": 1,
            "weight": 2.1
          }
        ],
        "user_attributes": {
          "email": "test@example.com",
          "first_name": "John",
          "last_name": "Smith"
        }
      }
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "id": 33,
        "tracking_number": "PPuqD0J0uLslM",
        "state": "order_placed",
        "delivery_address": "1 Union Street",
        "delivery_suburb": "Pyrmont",
        "delivery_postcode": "2009",
        "delivery_state": "NSW",
        "delivery_country_code": "AU",
        "receiver_name": "John Smith",
        "receiver_contact_number": null,
        "courier_name": "CouriersPlease",
        "slug": "ppuqd0j0ulslm",
        "price": "0.0",
        "retailer_invoice": null,
        "courier_job_id": null,
        "user_attributes": {
          "email": "test@example.com",
          "first_name": "John",
          "last_name": "Smith"
        },
        "parcel_attributes": [
          {
            "qty": 1,
            "weight": 2.1
          }
        ]
      }
    }
    ```
  </Accordion>

  <Accordion title="get-order: Get order details">
    <ParamField body="tracking_number" type="string" required>
      Shippit tracking number (usually starts with `PP`).
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "tracking_number": "PPuqD0J0uLslM"
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "authority_to_leave": "Yes",
        "cash_on_delivery_amount": 0.0,
        "courier_type": "standard",
        "courier_allocation": "CouriersPlease",
        "receiver_contact_number": "0400000000",
        "receiver_name": "Receiver Name",
        "receiver_language_code": "EN",
        "retailer_invoice": "Retailer Invoice",
        "retailer_reference": "Retailer Reference",
        "product_currency": "AUD",
        "suppress_communications": false,
        "tracking_only": false,
        "features": [],
        "description": "",
        "duties": 0.0,
        "tax_amount": 0.0,
        "return": false,
        "delivery_company": "Delivery Company",
        "delivery_address": "1 Test Street",
        "delivery_suburb": "Sydney",
        "delivery_state": "NSW",
        "delivery_postcode": "2000",
        "delivery_country_code": "AU",
        "delivery_timezone": "Australia/Sydney",
        "delivery_instructions": "Leave on door",
        "state": "order_placed",
        "user_attributes": {
          "email": "test@example.com",
          "first_name": "Test",
          "last_name": "Example",
          "mobile": "0400000000"
        },
        "parcel_attributes": [
          {
            "qty": 1,
            "length": 0.1,
            "width": 0.2,
            "depth": 0.3,
            "weight": 20.0,
            "label_number": "PARCELLABEL01"
          }
        ],
        "product_attributes": [
          {
            "price": 12.34,
            "tariff_code": "62121000",
            "quantity": 1,
            "title": "Title",
            "sku": "SKU12345",
            "dangerous_goods_code": "1",
            "dangerous_goods_text": "Explosives",
            "origin_country_code": "AU",
            "product_line_id": "PL1",
            "location": "Loc1",
            "dangerous_goods_class": "EXP",
            "packed": 1
          }
        ]
      }
    }
    ```
  </Accordion>

  <Accordion title="update-order: Update an existing order">
    <ParamField body="tracking_number" type="string" required>
      Shippit tracking number.
    </ParamField>

    <ParamField body="order" type="object" required>
      Fields to update on the order.
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "tracking_number": "PPuqD0J0uLslM",
      "order": {
        "authority_to_leave": "Yes",
        "courier_type": "standard",
        "receiver_contact_number": "0400000000",
        "receiver_name": "Receiver Name",
        "delivery_address": "1 Test Street",
        "delivery_suburb": "Sydney",
        "delivery_state": "NSW",
        "delivery_postcode": "2000",
        "delivery_country_code": "AU",
        "delivery_instructions": "Leave on door",
        "user_attributes": {
          "email": "test@example.com",
          "first_name": "Test",
          "last_name": "Example",
          "mobile": "0400000000"
        },
        "parcel_attributes": [
          {
            "qty": 1,
            "length": 0.1,
            "width": 0.2,
            "depth": 0.3,
            "weight": 20.0,
            "label_number": "PARCELLABEL01"
          }
        ]
      }
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "authority_to_leave": "Yes",
        "courier_type": "standard",
        "courier_allocation": "CouriersPlease",
        "receiver_contact_number": "0400000000",
        "receiver_name": "Receiver Name",
        "delivery_address": "1 Test Street",
        "delivery_suburb": "Sydney",
        "delivery_state": "NSW",
        "delivery_postcode": "2000",
        "delivery_country_code": "AU",
        "delivery_instructions": "Leave on door",
        "state": "order_placed",
        "user_attributes": {
          "email": "test@example.com",
          "first_name": "Test",
          "last_name": "Example",
          "mobile": "0400000000"
        },
        "parcel_attributes": [
          {
            "qty": 1,
            "length": 0.1,
            "width": 0.2,
            "depth": 0.3,
            "weight": 20.0,
            "label_number": "PARCELLABEL01"
          }
        ]
      }
    }
    ```
  </Accordion>

  <Accordion title="cancel-order: Cancel an order">
    <ParamField body="tracking_number" type="string" required>
      Shippit tracking number.
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "tracking_number": "PPuqD0J0uLslM"
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "id": 33,
        "tracking_number": "PPuqD0J0uLslM",
        "state": "cancelled",
        "processing_state": "processing_cancelled",
        "delivery_address": "1 Union Street",
        "delivery_suburb": "Pyrmont",
        "delivery_postcode": "2009",
        "receiver_name": "Francois",
        "receiver_contact_number": "0404342342",
        "courier_name": "eParcel International",
        "slug": "ppuqd0j0ulslm",
        "price": "0.0",
        "retailer_invoice": "SO42637",
        "courier_job_id": "ABC0100023",
        "user_attributes": {
          "email": "test@example.com",
          "first_name": "John",
          "last_name": "Smith"
        },
        "parcel_attributes": [
          {
            "qty": 1,
            "length": 0.325,
            "width": 0.205,
            "depth": 0.03,
            "weight": 0.5
          }
        ]
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### Tracking & Labels

<AccordionGroup>
  <Accordion title="track-order: Get tracking status and events">
    <ParamField body="tracking_number" type="string" required>
      Shippit tracking number.
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "tracking_number": "PP39TBECV7QSSPK"
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "tracking_number": "PP39TBECV7QSSPK",
        "tracking_url": "http://app.shippit.com/tracking/pp39tbecv7qsspk",
        "success": true,
        "track": [
          {
            "status": "Completed",
            "date": "2015-04-03T00:00:00.000Z",
            "timestamp": 58985,
            "status_owner": "Bonds Couriers"
          },
          {
            "status": "With Driver",
            "date": "2015-04-03T00:00:00.000Z",
            "timestamp": 55385,
            "status_owner": "Bonds Couriers"
          },
          {
            "status": "In Transit",
            "date": "2015-04-03T00:00:00.000Z",
            "timestamp": 55325,
            "status_owner": "Bonds Couriers"
          },
          {
            "status": "Ready For Pick Up",
            "date": "2015-04-03T00:00:00.000Z",
            "timestamp": 49400,
            "status_owner": "Harold's Harpoons"
          },
          {
            "status": "Despatch In Progress",
            "date": "2015-04-03T00:00:00.000Z",
            "timestamp": 36603,
            "status_owner": "Harold's Harpoons"
          },
          {
            "status": "Order Placed",
            "date": "2015-04-03T00:00:00.000Z",
            "timestamp": "07:23:32",
            "status_owner": "Harold's Harpoons"
          }
        ]
      }
    }
    ```
  </Accordion>

  <Accordion title="get-label: Get shipping label URL">
    <ParamField body="tracking_number" type="string" required>
      Shippit tracking number.
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "tracking_number": "PPKFqy44U8Nff"
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "id": 5044,
        "order": {
          "courier_delivery_instructions": "Authority to Leave. ",
          "courier_job_id": "SHP0100002",
          "delivery_address": "37 Manorvale Pde",
          "delivery_instructions": "",
          "delivery_postcode": "3030",
          "delivery_state": "VIC",
          "delivery_suburb": "Werribee",
          "id": 9972,
          "invoice_number": "INV-1384",
          "parcels": [
            {
              "depth": 0.19,
              "length": 0.38,
              "name": "",
              "weight": 1,
              "width": 0.29,
              "label_number": "SHP010000201000930803"
            }
          ],
          "products": [
            {
              "title": "Industrial Paint Stripper",
              "price": 29.13,
              "sku": "0.1",
              "quantity": 1,
              "tariff_code": "000999",
              "origin_country_code": "TH"
            }
          ],
          "price": "15.95",
          "receiver_name": "Jane Doe",
          "slug": "ppkfqy44u8nff",
          "state": "completed",
          "tracking_number": "PPKFqy44U8Nff",
          "user": {
            "email": "jane.doe@example.com",
            "first_name": "Jane",
            "last_name": "Doe"
          },
          "documents": {
            "shipping_label": {
              "url": "https://shippit-production.s3.amazonaws.com/uploads/label/attachment/5044/PPKFqy44U8Nff.pdf",
              "page_size": "a6",
              "file_type": "pdf"
            }
          }
        },
        "qualified_url": "https://shippit-production.s3.amazonaws.com/uploads/label/attachment/5044/PPKFqy44U8Nff.pdf"
      }
    }
    ```
  </Accordion>

  <Accordion title="book-order: Book carrier for an order">
    <ParamField body="tracking_number" type="string" required>
      Shippit tracking number.
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "tracking_number": "PPuqD0J0uLslM"
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": [
        {
          "courier": "eParcel Express",
          "manifest": "ABC0000214",
          "manifest_pdf": "https://shippit.com/manifest20160721-96368-1tpowvr.pdf",
          "order_count": 2,
          "success": true
        },
        {
          "courier": "Fastway",
          "manifest": "FW20160721215",
          "manifest_pdf": "https://shippit.com/manifest20160721-96368-1tpowvr.pdf",
          "order_count": 2,
          "success": true
        },
        {
          "courier": "Couriers Please",
          "manifest": "JJJ20160721216",
          "manifest_pdf": "https://shippit.com/manifest20160721-96368-1tpowvr.pdf",
          "order_count": 4,
          "success": true
        }
      ],
      "count": 3
    }
    ```
  </Accordion>
</AccordionGroup>

### Merchant

<AccordionGroup>
  <Accordion title="get-merchant-settings: Get account settings">
    No parameters required.

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "store_name": "Harolds Harpoons",
        "company_name": "Harold Pty Ltd",
        "contact_name": "Robert",
        "contact_phone": "0400000000",
        "shipping_cart_method_name": "",
        "preparation_time": 60,
        "website_url": "www.haroldsharpoons.com.au",
        "address_1": "110 Rex Road",
        "suburb": "Sydney",
        "state": "NSW",
        "postcode": "2000",
        "country_code": "AU"
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### Advanced

<AccordionGroup>
  <Accordion title="raw-api-request: Make an arbitrary API request">
    Send a request to any Shippit API endpoint.

    <ParamField body="method" type="string" required>
      HTTP method: `GET`, `POST`, `PUT`, or `DELETE`.
    </ParamField>

    <ParamField body="path" type="string" required>
      API path (e.g., `/orders` or `/returns`).
    </ParamField>

    <ParamField body="body" type="object">
      Request body (for POST/PUT).
    </ParamField>

    **Example request:**

    ```json theme={null}
    {
      "method": "GET",
      "path": "/merchant/settings"
    }
    ```

    **Example response:**

    ```json theme={null}
    {
      "response": {
        "store_name": "Harolds Harpoons",
        "company_name": "Harold Pty Ltd",
        "contact_name": "Robert",
        "contact_phone": "0400000000",
        "website_url": "www.haroldsharpoons.com.au",
        "address_1": "110 Rex Road",
        "suburb": "Sydney",
        "state": "NSW",
        "postcode": "2000",
        "country_code": "AU"
      }
    }
    ```
  </Accordion>
</AccordionGroup>