Salla

Salla Shipments API

The Shipments API from Salla — 4 operation(s) for shipments.

Documentation GitHub OpenAPI

Business capability

Logistics Operations Management BC-520.50

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /shipments List shipments · List Shipments #

Ask an LLM

“Which shipments has my Salla store created?”

“Can I see all outgoing shipments in one list?”

Tell an agent

List all shipments.

Show my store's shipments.

POST /shipments Create a shipment for an order · Create Shipment #

Ask an LLM

“How do I create a shipment for an order with a courier?”

“Can I attach a tracking number when creating a shipment?”

Tell an agent

Create a shipment for order {order_id} with courier {courier_id}.

Ship order {order_id} via courier {courier_id} with tracking number {tracking_number}.

GET /shipments/{shipment_id} Get a shipment's details · Get Shipment Details #

Ask an LLM

“What is the status and tracking info of a specific shipment?”

“Can I look up one shipment by ID?”

Tell an agent

Show me shipment {shipment_id}.

Get the details of shipment {shipment_id}.

PUT /shipments/{shipment_id} Update a shipment · Update Shipment #

Ask an LLM

“How do I edit an existing shipment?”

“Can I change details on a shipment already created?”

Tell an agent

Update shipment {shipment_id}.

Edit the details of shipment {shipment_id}.

POST /shipments/{shipment_id}/cancel Cancel a shipment · Cancel Shipment #

Ask an LLM

“How do I cancel a shipment that should not go out?”

“Can I call off a shipment after creating it?”

Tell an agent destructive · confirm first

Cancel shipment {shipment_id}.

Stop shipment {shipment_id} from going out.

POST /shipments/{shipment_id}/return Create a return for a shipment · Create Shipment Return #

Ask an LLM

“How do I arrange a return for a delivered shipment?”

“Can I create a return shipment so the customer can send items back?”

Tell an agent

Create a return for shipment {shipment_id}.

Set up a return shipment for {shipment_id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/salla:salla-shipments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Salla Shipping and Fulfillment Shipments API
  description: 'REST surface for managing and tracking shipments, shipping zones, pickup

    branches, and courier integrations across Salla merchant stores. Shipping

    apps that implement this contract are listed in the Salla App Store and

    receive shipment lifecycle webhooks (`shipment.creating`,

    `shipment.created`, `shipment.cancelled`).'
  version: '2'
  contact:
    name: Salla Developers
    url: https://docs.salla.dev/
    email: support@salla.dev
servers:
- url: https://api.salla.dev/admin/v2
  description: Salla Shipping API production
security:
- OAuth2: []
tags:
- name: Shipments
paths:
  /shipments:
    get:
      summary: List Shipments
      operationId: listShipments
      tags:
      - Shipments
      responses:
        '200':
          description: Shipments list.
    post:
      summary: Create Shipment
      operationId: createShipment
      tags:
      - Shipments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentCreate'
      responses:
        '201':
          description: Shipment created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shipment'
  /shipments/{shipment_id}:
    parameters:
    - name: shipment_id
      in: path
      required: true
      schema:
        type: integer
    get:
      summary: Get Shipment Details
      operationId: getShipment
      tags:
      - Shipments
      responses:
        '200':
          description: Shipment details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shipment'
    put:
      summary: Update Shipment
      operationId: updateShipment
      tags:
      - Shipments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Shipment updated.
  /shipments/{shipment_id}/cancel:
    parameters:
    - name: shipment_id
      in: path
      required: true
      schema:
        type: integer
    post:
      summary: Cancel Shipment
      operationId: cancelShipment
      tags:
      - Shipments
      responses:
        '200':
          description: Shipment cancelled.
  /shipments/{shipment_id}/return:
    parameters:
    - name: shipment_id
      in: path
      required: true
      schema:
        type: integer
    post:
      summary: Create Shipment Return
      operationId: createShipmentReturn
      tags:
      - Shipments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Shipment return created.
components:
  schemas:
    Shipment:
      type: object
      properties:
        id:
          type: integer
        order_id:
          type: integer
        courier_id:
          type: integer
        courier_name:
          type: string
        tracking_number:
          type: string
        tracking_link:
          type: string
          format: uri
        status:
          type: string
        type:
          type: string
          enum:
          - shipment
          - return
        total:
          type: number
        currency:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ShipmentCreate:
      type: object
      required:
      - order_id
      - courier_id
      properties:
        order_id:
          type: integer
        courier_id:
          type: integer
        type:
          type: string
          enum:
          - shipment
          - return
        tracking_number:
          type: string
        tracking_link:
          type: string
          format: uri
        cost:
          type: number
        pickup_address:
          type: object
        ship_to:
          type: object
        packages:
          type: array
          items:
            type: object
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.salla.sa/oauth2/auth
          tokenUrl: https://accounts.salla.sa/oauth2/token
          refreshUrl: https://accounts.salla.sa/oauth2/token
          scopes:
            offline_access: Required to receive a refresh token.
            shipments.read: Read shipments.
            shipments.read_write: Read and write shipments.

Salla Shipments API

Operations 6

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification