Salla

Salla Shipments API

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

GitHub OpenAPI

Operations 6

GET /shipments List Shipments #
POST /shipments Create Shipment #
GET /shipments/{shipment_id} Get Shipment Details #
PUT /shipments/{shipment_id} Update Shipment #
POST /shipments/{shipment_id}/cancel Cancel Shipment #
POST /shipments/{shipment_id}/return Create Shipment Return #

Documentation

📖
Documentation
https://docs.salla.dev/421117m0
📖
Documentation
https://docs.salla.dev/5394168e0
📖
Documentation
https://docs.salla.dev/5394147e0
📖
Documentation
https://docs.salla.dev/421118m0
📖
Documentation
https://docs.salla.dev/5394234e0
📖
Documentation
https://docs.salla.dev/5394248e0

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/openapi/salla-shipments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-schema/salla-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-schema/salla-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-schema/salla-customer-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-ld/salla-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/examples/salla-list-products-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/examples/salla-create-order-example.json

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-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

salla-shipments-api-openapi.yml Raw ↑ 
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:
    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
    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
  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.