Default

PreviousPackage Services NextTransfer Order Services

Was this helpful?

List packages

get

Get a list of Packages Objects for listing

Authorizations

Query parameters

formatstring · enumOptional

Response format

Default: jsonPossible values:

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

sortstring · enumOptional

Sorting field

Possible values:

stateintegerOptional

Filter by state ID

state__enum_valuestringOptional

Filter by state enum value

state__enum_value__neqstringOptional

Filter by state enum value not equal

orderintegerOptional

Filter by order ID

stock_locationintegerOptional

Filter by stock location ID

stock_location__erp_codestringOptional

Filter by stock location ERP code

stock_location__erp_code__instringOptional

Filter by multiple stock location ERP codes (comma separated)

stock_location__stock_location_typestringOptional

Filter by stock location type

order_numberstringOptional

Filter by order number (starts with)

order_omnitron_idintegerOptional

Filter by order Omnitron ID

start_datestring · dateOptional

Filter by created date (from)

end_datestring · dateOptional

Filter by created date (to)

modified_start_datestring · dateOptional

Filter by modified date (from)

modified_end_datestring · dateOptional

Filter by modified date (to)

shipment_created_start_datestring · date-timeOptional

Filter by shipment created date (from)

shipment_created_end_datestring · date-timeOptional

Filter by shipment created date (to)

product__skustringOptional

Filter by product SKU

product__barcodestringOptional

Filter by product barcode

delivery_range_lowerstring · date-timeOptional

Filter by delivery range lower bound

delivery_range_upperstring · date-timeOptional

Filter by delivery range upper bound

delivery_range_datestring · dateOptional

Filter by delivery range date

channelintegerOptional

Filter by channel ID

customer__first_namestringOptional

Filter by customer first name

customer__last_namestringOptional

Filter by customer last name

order__datestring · dateOptional

Filter by order date

order__date_placed__gtestring · dateOptional

Filter by order date placed (from)

order__date_placed__ltestring · dateOptional

Filter by order date placed (to)

shipment__cargo_companyintegerOptional

Filter by shipment cargo company ID

packageitem__order_item__omnitron_id__ininteger[]Optional

Filter by multiple packageitem order item omnitron IDs

is_click_and_collectbooleanOptional

Filter by click and collect status

id__gtintegerOptional

Filter by ID greater than

id__gteintegerOptional

Filter by ID greater than or equal

id__ltintegerOptional

Filter by ID less than

id__lteintegerOptional

Filter by ID less than or equal

pk__ininteger[]Optional

Filter by multiple IDs

order__delivery_typestring · enumOptional

Filter by order delivery type

Possible values:

countryintegerOptional

Filter by country ID

country__namestringOptional

Filter by country name

cityintegerOptional

Filter by city ID

city__namestringOptional

Filter by city name

townshipintegerOptional

Filter by township ID

township__namestringOptional

Filter by township name

has_cancellation_failurebooleanOptional

Filter by cancellation failure status

order__retail_store__erp_codestringOptional

Filter by order retail store ERP code

sl_rs__erp_codestringOptional

Filter by stock location or retail store ERP code

shipping_option_slug__instring[]Optional

Filter by shipping option slugs

shipping_option_slug__excludestring[]Optional

Exclude by shipping option slugs

order_item__omnitron_idintegerOptional

Filter by order item omnitron ID

Responses

200

Successful operation

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

GET /packages/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "packageitem_set": [
        {
          "id": 1,
          "state": {
            "id": 1,
            "created_date": "2025-05-22T13:18:03.560Z",
            "modified_date": "2025-05-22T13:18:03.560Z",
            "name": "text",
            "config": {},
            "enum_class": "text",
            "enum_value": "text",
            "content_type": 1
          },
          "order_item": {},
          "transfer_order": {},
          "created_date": "2025-05-22T13:18:03.560Z",
          "modified_date": "2025-05-22T13:18:03.560Z",
          "package": 1,
          "denial_reason": {
            "id": 1,
            "title": "text",
            "remote_id": "text",
            "priority": 1,
            "is_active": true
          },
          "discrepancy_reason": "text",
          "unit_type": "quantity"
        }
      ],
      "order_number": "text",
      "channel_name": "text",
      "state": {
        "id": 1,
        "created_date": "2025-05-22T13:18:03.560Z",
        "modified_date": "2025-05-22T13:18:03.560Z",
        "name": "text",
        "config": {},
        "enum_class": "text",
        "enum_value": "text",
        "content_type": 1
      },
      "number": "text",
      "id": 1,
      "shipping_address": {
        "id": 1,
        "city": {},
        "country": {},
        "township": {},
        "district": {},
        "customer": {},
        "title": "text",
        "line": "text",
        "email": "text",
        "phone_number": "text",
        "first_name": "text",
        "last_name": "text",
        "is_active": true
      },
      "order_id": 1,
      "stock_location": {
        "id": 1,
        "name": "text",
        "erp_code": "text",
        "address": {
          "id": 1,
          "city": {},
          "country": {},
          "township": {},
          "district": {},
          "customer": {},
          "title": "text",
          "line": "text",
          "email": "text",
          "phone_number": "text",
          "first_name": "text",
          "last_name": "text",
          "is_active": true
        },
        "tags": [
          {}
        ]
      },
      "commands": [
        {}
      ],
      "shipment": {},
      "shipping_label": {},
      "is_click_and_collect": true,
      "shipment_date": "2025-05-22T13:18:03.560Z",
      "extra_information": {},
      "delivery_type": {
        "value": "text",
        "label": "text"
      },
      "omnitron_order_id": 1,
      "id_encrypted": "text",
      "scenario": {
        "name": "text",
        "id": 1
      },
      "rule": {
        "name": "text",
        "id": 1
      }
    },
    {
      "date_placed": "2025-05-22T13:18:03.560Z",
      "city": "text",
      "payment_type": "text",
      "tracking_number": "text",
      "target_packing_date": "2025-05-22T13:18:03.560Z",
      "invoice_number": "text",
      "remote_id": "text",
      "delivery_range": {
        "lower": "2025-05-22T13:18:03.560Z",
        "upper": "2025-05-22T13:18:03.560Z"
      },
      "order_gift_box_note": "text",
      "order_has_gift_box": true,
      "order_retail_store_id": 1,
      "order_notes": "text",
      "created_date": "2025-05-22T13:18:03.560Z",
      "modified_date": "2025-05-22T13:18:03.560Z",
      "channel_omnitron_id": 1,
      "source": "oms",
      "origin_address": 1,
      "origin_address_id": "text"
    }
  ]
}

Get a package

get

Get a single Package object with given id

Authorizations

Path parameters

idintegerRequired

Query parameters

formatstring · enumOptional

Response format

Default: jsonPossible values:

Responses

200

Successful operation

Responseall of

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "packageitem_set": [
    {
      "id": 1,
      "state": {
        "id": 1,
        "created_date": "2025-05-22T13:18:03.560Z",
        "modified_date": "2025-05-22T13:18:03.560Z",
        "name": "text",
        "config": {},
        "enum_class": "text",
        "enum_value": "text",
        "content_type": 1
      },
      "order_item": {},
      "transfer_order": {},
      "created_date": "2025-05-22T13:18:03.560Z",
      "modified_date": "2025-05-22T13:18:03.560Z",
      "package": 1,
      "denial_reason": {
        "id": 1,
        "title": "text",
        "remote_id": "text",
        "priority": 1,
        "is_active": true
      },
      "discrepancy_reason": "text",
      "unit_type": "quantity"
    }
  ],
  "order_number": "text",
  "channel_name": "text",
  "state": {
    "id": 1,
    "created_date": "2025-05-22T13:18:03.560Z",
    "modified_date": "2025-05-22T13:18:03.560Z",
    "name": "text",
    "config": {},
    "enum_class": "text",
    "enum_value": "text",
    "content_type": 1
  },
  "number": "text",
  "id": 1,
  "shipping_address": {
    "id": 1,
    "city": {},
    "country": {},
    "township": {},
    "district": {},
    "customer": {},
    "title": "text",
    "line": "text",
    "email": "text",
    "phone_number": "text",
    "first_name": "text",
    "last_name": "text",
    "is_active": true
  },
  "order_id": 1,
  "stock_location": {
    "id": 1,
    "name": "text",
    "erp_code": "text",
    "address": {
      "id": 1,
      "city": {},
      "country": {},
      "township": {},
      "district": {},
      "customer": {},
      "title": "text",
      "line": "text",
      "email": "text",
      "phone_number": "text",
      "first_name": "text",
      "last_name": "text",
      "is_active": true
    },
    "tags": [
      {}
    ]
  },
  "commands": [
    {}
  ],
  "shipment": {},
  "shipping_label": {},
  "is_click_and_collect": true,
  "shipment_date": "2025-05-22T13:18:03.560Z",
  "extra_information": {},
  "delivery_type": {
    "value": "text",
    "label": "text"
  },
  "omnitron_order_id": 1,
  "id_encrypted": "text",
  "scenario": {
    "name": "text",
    "id": 1
  },
  "rule": {
    "name": "text",
    "id": 1
  },
  "date_placed": "2025-05-22T13:18:03.560Z",
  "city": "text",
  "payment_type": "text",
  "tracking_number": "text",
  "target_packing_date": "2025-05-22T13:18:03.560Z",
  "invoice_number": "text",
  "remote_id": "text",
  "delivery_range": {
    "lower": "2025-05-22T13:18:03.560Z",
    "upper": "2025-05-22T13:18:03.560Z"
  },
  "order_gift_box_note": "text",
  "order_has_gift_box": true,
  "order_retail_store_id": 1,
  "order_notes": "text",
  "created_date": "2025-05-22T13:18:03.560Z",
  "modified_date": "2025-05-22T13:18:03.560Z",
  "channel_omnitron_id": 1,
  "source": "oms",
  "origin_address": 1,
  "origin_address_id": "text"
}

List packages with short format

get

Get a list of Packages with minimal information

Authorizations

Query parameters

formatstring · enumOptional

Response format

Default: jsonPossible values:

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

GET /packages/short/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "packageitem_count": 1,
      "order_number": "text",
      "date_placed": "2025-05-22T13:18:03.560Z",
      "channel_name": "text",
      "state": {
        "id": 1,
        "created_date": "2025-05-22T13:18:03.560Z",
        "modified_date": "2025-05-22T13:18:03.560Z",
        "name": "text",
        "config": {},
        "enum_class": "text",
        "enum_value": "text",
        "content_type": 1
      },
      "number": "text",
      "id": 1,
      "target_packing_date": "2025-05-22T13:18:03.560Z",
      "order_id": 1,
      "stock_location": {},
      "is_click_and_collect": true,
      "delivery_type": {
        "value": "text",
        "label": "text"
      },
      "created_date": "2025-05-22T13:18:03.560Z",
      "modified_date": "2025-05-22T13:18:03.560Z"
    }
  ]
}

Get a package with short format

get

Get a single Package object with minimal information

Authorizations

Path parameters

idintegerRequired

Responses

200

Successful operation

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/short/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "packageitem_set": [
    {
      "id": 1,
      "state": {
        "id": 1,
        "created_date": "2025-05-22T13:18:03.560Z",
        "modified_date": "2025-05-22T13:18:03.560Z",
        "name": "text",
        "config": {},
        "enum_class": "text",
        "enum_value": "text",
        "content_type": 1
      },
      "order_item": {},
      "transfer_order": {},
      "created_date": "2025-05-22T13:18:03.560Z",
      "modified_date": "2025-05-22T13:18:03.560Z",
      "package": 1,
      "denial_reason": {
        "id": 1,
        "title": "text",
        "remote_id": "text",
        "priority": 1,
        "is_active": true
      },
      "discrepancy_reason": "text",
      "unit_type": "quantity"
    }
  ],
  "order_number": "text",
  "channel_name": "text",
  "state": {
    "id": 1,
    "created_date": "2025-05-22T13:18:03.560Z",
    "modified_date": "2025-05-22T13:18:03.560Z",
    "name": "text",
    "config": {},
    "enum_class": "text",
    "enum_value": "text",
    "content_type": 1
  },
  "number": "text",
  "id": 1,
  "shipping_address": {
    "id": 1,
    "city": {},
    "country": {},
    "township": {},
    "district": {},
    "customer": {},
    "title": "text",
    "line": "text",
    "email": "text",
    "phone_number": "text",
    "first_name": "text",
    "last_name": "text",
    "is_active": true
  },
  "order_id": 1,
  "stock_location": {
    "id": 1,
    "name": "text",
    "erp_code": "text",
    "address": {
      "id": 1,
      "city": {},
      "country": {},
      "township": {},
      "district": {},
      "customer": {},
      "title": "text",
      "line": "text",
      "email": "text",
      "phone_number": "text",
      "first_name": "text",
      "last_name": "text",
      "is_active": true
    },
    "tags": [
      {}
    ]
  },
  "commands": [
    {}
  ],
  "shipment": {},
  "shipping_label": {},
  "is_click_and_collect": true,
  "shipment_date": "2025-05-22T13:18:03.560Z",
  "extra_information": {},
  "delivery_type": {
    "value": "text",
    "label": "text"
  },
  "omnitron_order_id": 1,
  "id_encrypted": "text",
  "scenario": {
    "name": "text",
    "id": 1
  },
  "rule": {
    "name": "text",
    "id": 1
  }
}

Get delivery ranges

get

Returns distinct delivery ranges available

Authorizations

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

datestring · date-timeOptional

Filter by exact date within delivery range

lower_start_datestring · date-timeOptional

Filter by lower bound start date

lower_end_datestring · date-timeOptional

Filter by lower bound end date

upper_start_datestring · date-timeOptional

Filter by upper bound start date

upper_end_datestring · date-timeOptional

Filter by upper bound end date

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

GET /packages/delivery-ranges/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "lower": "2025-05-22T13:18:03.560Z",
      "upper": "2025-05-22T13:18:03.560Z"
    }
  ]
}

Create invoice for package

post

Create a Purchased Invoice for the Package object

Authorizations

Path parameters

idintegerRequired

Responses

201

Invoice created successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

POST /packages/{id}/invoice/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": 1,
  "invoice_type": "text",
  "status": "text",
  "channel": {},
  "address": {
    "id": 1,
    "city": {},
    "country": {},
    "township": {},
    "district": {},
    "customer": {},
    "title": "text",
    "line": "text",
    "email": "text",
    "phone_number": "text",
    "first_name": "text",
    "last_name": "text",
    "is_active": true
  },
  "invoiceitem_set": [
    {}
  ],
  "order": {},
  "package_number": "text",
  "created_date": "2025-05-22T13:18:03.560Z",
  "modified_date": "2025-05-22T13:18:03.560Z",
  "number": "text"
}

Get package items

get

Get items for a specific package

Authorizations

Path parameters

idintegerRequired

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/package-items/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "product_sku": "text"
    }
  ]
}

Get invoice document

get

Get invoice document for a package

Authorizations

Path parameters

idintegerRequired

Responses

200

Successful operation (HTML content)

application/json

202

Invoice URL already exists

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/invoice_document/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "html_content": "text"
}

List package transition logs

get

Get a list of transition logs for a specific package

Authorizations

Path parameters

idintegerRequired

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/transition_logs/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "created_date": "2025-05-22T13:18:03.560Z",
      "modified_date": "2025-05-22T13:18:03.560Z",
      "source_state": {
        "id": 1,
        "created_date": "2025-05-22T13:18:03.560Z",
        "modified_date": "2025-05-22T13:18:03.560Z",
        "name": "text",
        "config": {},
        "enum_class": "text",
        "enum_value": "text",
        "content_type": 1
      },
      "target_state": {
        "id": 1,
        "created_date": "2025-05-22T13:18:03.560Z",
        "modified_date": "2025-05-22T13:18:03.560Z",
        "name": "text",
        "config": {},
        "enum_class": "text",
        "enum_value": "text",
        "content_type": 1
      },
      "transition": {
        "id": 1,
        "name": "text",
        "source_state": 1,
        "target_state": 1
      },
      "content_type": {
        "id": 1,
        "app_label": "text",
        "model": "text"
      },
      "object_id": 1,
      "additional_data": {},
      "user": {
        "id": 1,
        "username": "text",
        "email": "text"
      }
    }
  ]
}

Get package transition log

get

Get a specific transition log for a package

Authorizations

Path parameters

idintegerRequired

log_idintegerRequired

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/transition_logs/{log_id}/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": 1,
  "created_date": "2025-05-22T13:18:03.560Z",
  "modified_date": "2025-05-22T13:18:03.560Z",
  "source_state": {
    "id": 1,
    "created_date": "2025-05-22T13:18:03.560Z",
    "modified_date": "2025-05-22T13:18:03.560Z",
    "name": "text",
    "config": {},
    "enum_class": "text",
    "enum_value": "text",
    "content_type": 1
  },
  "target_state": {
    "id": 1,
    "created_date": "2025-05-22T13:18:03.560Z",
    "modified_date": "2025-05-22T13:18:03.560Z",
    "name": "text",
    "config": {},
    "enum_class": "text",
    "enum_value": "text",
    "content_type": 1
  },
  "transition": {
    "id": 1,
    "name": "text",
    "source_state": 1,
    "target_state": 1
  },
  "content_type": {
    "id": 1,
    "app_label": "text",
    "model": "text"
  },
  "object_id": 1,
  "additional_data": {},
  "user": {
    "id": 1,
    "username": "text",
    "email": "text"
  }
}

List package transition logs (short format)

get

Get a list of transition logs for a specific package in short format

Authorizations

Path parameters

idintegerRequired

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/transition_logs/short/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "created_date": "2025-05-22T13:18:03.560Z",
      "source_state": {
        "name": "text",
        "enum_value": "text"
      },
      "target_state": {
        "name": "text",
        "enum_value": "text"
      },
      "transition_name": "text",
      "user": "text"
    }
  ]
}

Get package transition log (short format)

get

Get a specific transition log for a package in short format

Authorizations

Path parameters

idintegerRequired

log_idintegerRequired

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/transition_logs/short/{log_id}/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": 1,
  "created_date": "2025-05-22T13:18:03.560Z",
  "source_state": {
    "name": "text",
    "enum_value": "text"
  },
  "target_state": {
    "name": "text",
    "enum_value": "text"
  },
  "transition_name": "text",
  "user": "text"
}

List package webhook events

get

Get a list of webhook events for a specific package

Authorizations

Path parameters

idintegerRequired

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/webhook_events/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "created_date": "2025-05-22T13:18:03.560Z",
      "modified_date": "2025-05-22T13:18:03.560Z",
      "event_type": "text",
      "content_type": {
        "id": 1,
        "app_label": "text",
        "model": "text"
      },
      "object_id": 1,
      "status": "pending",
      "payload": {},
      "response": {},
      "retryable": true,
      "retry_count": 1,
      "next_retry_date": "2025-05-22T13:18:03.560Z"
    }
  ]
}

Get package webhook event

get

Get a specific webhook event for a package

Authorizations

Path parameters

idintegerRequired

webhook_event_idintegerRequired

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/webhook_events/{webhook_event_id}/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": 1,
  "created_date": "2025-05-22T13:18:03.560Z",
  "modified_date": "2025-05-22T13:18:03.560Z",
  "event_type": "text",
  "content_type": {
    "id": 1,
    "app_label": "text",
    "model": "text"
  },
  "object_id": 1,
  "status": "pending",
  "payload": {},
  "response": {},
  "retryable": true,
  "retry_count": 1,
  "next_retry_date": "2025-05-22T13:18:03.560Z"
}

List package webhook events (short format)

get

Get a list of webhook events for a specific package in short format

Authorizations

Path parameters

idintegerRequired

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

GET /packages/{id}/webhook_events/short/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "created_date": "2025-05-22T13:18:03.560Z",
      "event_type": "text",
      "status": "pending",
      "retry_count": 1
    }
  ]
}

List packages in simplified format

get

Get a simplified list of packages with minimal information

Authorizations

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

stateintegerOptional

Filter by state ID

state__enum_valuestringOptional

Filter by state enum value

order_numberstringOptional

Filter by order number (starts with)

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

GET /packages/list-simple/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "number": "text",
      "state": {
        "id": 1,
        "created_date": "2025-05-22T13:18:03.560Z",
        "modified_date": "2025-05-22T13:18:03.560Z",
        "name": "text",
        "config": {},
        "enum_class": "text",
        "enum_value": "text",
        "content_type": 1
      },
      "order": 1,
      "stock_location": 1,
      "tracking_number": "text",
      "invoice_number": "text",
      "remote_id": "text",
      "shipping_address": 1,
      "is_click_and_collect": true,
      "shipment_date": "2025-05-22T13:18:03.560Z",
      "target_packing_date": "2025-05-22T13:18:03.560Z",
      "delivery_range": {
        "lower": "2025-05-22T13:18:03.560Z",
        "upper": "2025-05-22T13:18:03.560Z"
      },
      "created_date": "2025-05-22T13:18:03.560Z",
      "modified_date": "2025-05-22T13:18:03.560Z",
      "extra_information": {}
    }
  ]
}

Execute command for package

post

Execute specified command for Package objects

Authorizations

Path parameters

idintegerRequired

Body

transitionintegerRequired

ID of the state transition to execute

input_parametersobjectOptional

Additional parameters for the command

Default: {}

Responses

200

Command executed successfully

204

Command executed successfully (no content)

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

406

Not acceptable

application/json

post

POST /packages/{id}/command/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "transition": 1,
  "input_parameters": {}
}

No content

Set invoice number

post

Set invoice number for a package

Authorizations

Path parameters

idintegerRequired

Body

invoice_numberstring · max: 32Required

Responses

204

Invoice number set successfully

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

POST /packages/{id}/set_invoice_number/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "invoice_number": "text"
}

No content

Set remote ID

post

Set remote ID for a package

Authorizations

Path parameters

idintegerRequired

Body

remote_idstring · max: 128Required

Responses

204

Remote ID set successfully

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

POST /packages/{id}/set_remote_id/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "remote_id": "text"
}

No content

Update extra information

patch

Update extra information for a package

Authorizations

Path parameters

idintegerRequired

Body

extra_informationobjectRequired

Additional information for the package

Responses

200

Extra information updated successfully

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

PATCH /packages/{id}/extra_information/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "extra_information": {}
}

No content