Packages

PKG101: Get Packages

get

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset.

Default: 1

limitinteger · min: 1Optional

Specifies the row count of the current page.

Default: 10

numberstringOptional

Filter by exact value of the number field.

waybill_numberstringOptional

Filter by exact value of the waybill number field.

statusinteger · enumOptional

Filter by status field. Must be one of the provided integer values.

Possible values:

updated_atstring · date-timeOptional

Filters data where the "updated_at" field is exactly equal to a specified value.

updated_at__gtstring · date-timeOptional

Filters data where the "updated_at" field is greater than a specified value.

updated_at__gtestring · date-timeOptional

Filters data where the "updated_at" field is greater than or equal to a specified value.

updated_at__ltstring · date-timeOptional

Filters data where the "updated_at" field is less than a specified value.

updated_at__ltestring · date-timeOptional

Filters data where the "updated_at" field is less than or equal to a specified value.

created_atstring · date-timeOptional

Filters data where the "created_at" field is exactly equal to a specified value.

created_at__gtstring · date-timeOptional

Filters data where the "created_at" field is greater than a specified value.

created_at__gtestring · date-timeOptional

Filters data where the "created_at" field is greater than or equal to a specified value.

created_at__ltstring · date-timeOptional

Filters data where the "created_at" field is less than a specified value.

created_at__ltestring · date-timeOptional

Filters data where the "created_at" field is less than or equal to a specified value.

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

application/json

Responseall of

401

Unauthorized

application/json

500

Unexpected error.

get

/i2/packages/

GET /api/i2/packages/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://seller-center.akinon.com/api/i2/resource?page=2&limit=10",
  "previous": null,
  "results": [
    {
      "number": "2595053219311870",
      "order_number": "2594887831811953",
      "status": 2,
      "shipping_address": {
        "email": "[email protected]",
        "phone_number": "text",
        "first_name": "text",
        "last_name": "text",
        "country": "text",
        "country_code": "text",
        "city": "text",
        "township": "text",
        "district": "text",
        "line": "text",
        "postcode": "text",
        "company_name": "text",
        "tax_office": "text",
        "tax_no": "text",
        "e_bill_taxpayer": true,
        "identity_number": "text",
        "notes": "text"
      },
      "billing_address": {
        "email": "[email protected]",
        "phone_number": "text",
        "first_name": "text",
        "last_name": "text",
        "country": "text",
        "country_code": "text",
        "city": "text",
        "township": "text",
        "district": "text",
        "line": "text",
        "postcode": "text",
        "company_name": "text",
        "tax_office": "text",
        "tax_no": "text",
        "e_bill_taxpayer": true,
        "identity_number": "text",
        "notes": "text"
      },
      "currency": "TRY",
      "amount": 99.99,
      "discount_amount": 9.99,
      "net_amount": 90,
      "has_gift_box": true,
      "gift_box_note": "Happy Birthday!",
      "notes": "Please handle with care.",
      "date_placed": "2025-12-01T10:13:55.694Z",
      "shipping_method": "DHL - Standard",
      "shipping_company": {
        "name": "DHL",
        "slug": "dhl"
      },
      "is_requires_manual_entry": false,
      "waybill_number": "A456231",
      "tracking_number": "3457623412",
      "tracking_url": "https://akinon.com/track/3457623412",
      "shipment_date": "2025-12-01T10:13:55.694Z",
      "delivery_date": "2025-12-01T10:13:55.694Z",
      "invoice_date": "2025-12-01T10:13:55.694Z",
      "invoice_number": "IN-3457623412",
      "invoice_url": "https://akinon.com/invoice/IN-3457623412.pdf",
      "updated_at": "2025-12-01T10:13:55.694Z",
      "created_at": "2025-12-01T10:13:55.694Z"
    }
  ]
}

PKG102: Get Package Items

get

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset.

Default: 1

limitinteger · min: 1Optional

Specifies the row count of the current page.

Default: 10

updated_atstring · date-timeOptional

Filters data where the "updated_at" field is exactly equal to a specified value.

updated_at__gtstring · date-timeOptional

Filters data where the "updated_at" field is greater than a specified value.

updated_at__gtestring · date-timeOptional

Filters data where the "updated_at" field is greater than or equal to a specified value.

updated_at__ltstring · date-timeOptional

Filters data where the "updated_at" field is less than a specified value.

updated_at__ltestring · date-timeOptional

Filters data where the "updated_at" field is less than or equal to a specified value.

created_atstring · date-timeOptional

Filters data where the "created_at" field is exactly equal to a specified value.

created_at__gtstring · date-timeOptional

Filters data where the "created_at" field is greater than a specified value.

created_at__gtestring · date-timeOptional

Filters data where the "created_at" field is greater than or equal to a specified value.

created_at__ltstring · date-timeOptional

Filters data where the "created_at" field is less than a specified value.

created_at__ltestring · date-timeOptional

Filters data where the "created_at" field is less than or equal to a specified value.

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

application/json

Responseall of

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

get

/i2/packages/{number}/items/

GET /api/i2/packages/{number}/items/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://seller-center.akinon.com/api/i2/resource?page=2&limit=10",
  "previous": null,
  "results": [
    {
      "number": "2595053219311870-1",
      "status": 1,
      "product": "AKN-TSHRT-RD",
      "amount": 99.99,
      "discount_amount": 9.99,
      "net_amount": 90,
      "tax_rate": 0.1,
      "has_reservation": true,
      "updated_at": "2025-12-01T10:13:55.694Z",
      "created_at": "2025-12-01T10:13:55.694Z"
    }
  ]
}

PKG103: Update Package

put

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

statusinteger · enumOptional

Status of the package:

2 - Preparing: The package is being prepared for shipment.
3 - Ready to Ship: The package is ready to be shipped.
4 - Shipped: The package has been shipped.
5 - Delivered: The package has been successfully delivered.
6 - Delivery Failed: The delivery of the package has failed.

Example: 3Possible values:

waybill_numberstringOptional

Unique identifier for the waybill associated with the package.

Example: A456231

tracking_numberstringOptional

Tracking number for monitoring the package's shipment progress.

Example: 3457623412

tracking_urlstring · uriOptional

URL for tracking the package online.

Example: https://akinon.com/track/3457623412

shipping_companystring · stringOptional

Name of the shipping company handling the package.

Example: DHL

shipment_datestring · date-timeOptional

Date and time when the package was shipped.

Example: 2022-01-01T12:00:00Z

delivery_datestring · date-timeOptional

Date and time when the package was delivered.

Example: 2022-01-02T12:00:00Z

invoice_datestring · date-timeOptional

Date and time when the invoice for the package was generated.

Example: 2022-01-01T12:00:00Z

invoice_numberstringOptional

Unique identifier or number associated with the package's invoice.

Example: IN-3457623412

invoice_urlstring · urlOptional

URL for the package's invoice.

Example: https://akinon.com/invoice/IN-3457623412.pdf

Responses

200

application/json

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

put

/i2/packages/{number}/

PUT /api/i2/packages/{number}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "status": 3,
  "waybill_number": "A456231",
  "tracking_number": "3457623412",
  "tracking_url": "https://akinon.com/track/3457623412",
  "shipping_company": "DHL",
  "shipment_date": "2022-01-01T12:00:00Z",
  "delivery_date": "2022-01-02T12:00:00Z",
  "invoice_date": "2022-01-01T12:00:00Z",
  "invoice_number": "IN-3457623412",
  "invoice_url": "https://akinon.com/invoice/IN-3457623412.pdf"
}

{
  "number": "2595053219311870",
  "order_number": "2594887831811953",
  "status": 2,
  "shipping_address": {
    "email": "[email protected]",
    "phone_number": "text",
    "first_name": "text",
    "last_name": "text",
    "country": "text",
    "country_code": "text",
    "city": "text",
    "township": "text",
    "district": "text",
    "line": "text",
    "postcode": "text",
    "company_name": "text",
    "tax_office": "text",
    "tax_no": "text",
    "e_bill_taxpayer": true,
    "identity_number": "text",
    "notes": "text"
  },
  "billing_address": {
    "email": "[email protected]",
    "phone_number": "text",
    "first_name": "text",
    "last_name": "text",
    "country": "text",
    "country_code": "text",
    "city": "text",
    "township": "text",
    "district": "text",
    "line": "text",
    "postcode": "text",
    "company_name": "text",
    "tax_office": "text",
    "tax_no": "text",
    "e_bill_taxpayer": true,
    "identity_number": "text",
    "notes": "text"
  },
  "currency": "TRY",
  "amount": 99.99,
  "discount_amount": 9.99,
  "net_amount": 90,
  "has_gift_box": true,
  "gift_box_note": "Happy Birthday!",
  "notes": "Please handle with care.",
  "date_placed": "2025-12-01T10:13:55.694Z",
  "shipping_method": "DHL - Standard",
  "shipping_company": {
    "name": "DHL",
    "slug": "dhl"
  },
  "is_requires_manual_entry": false,
  "waybill_number": "A456231",
  "tracking_number": "3457623412",
  "tracking_url": "https://akinon.com/track/3457623412",
  "shipment_date": "2025-12-01T10:13:55.694Z",
  "delivery_date": "2025-12-01T10:13:55.694Z",
  "invoice_date": "2025-12-01T10:13:55.694Z",
  "invoice_number": "IN-3457623412",
  "invoice_url": "https://akinon.com/invoice/IN-3457623412.pdf",
  "updated_at": "2025-12-01T10:13:55.694Z",
  "created_at": "2025-12-01T10:13:55.694Z"
}

PKG104: Get Cargo Label

get

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

application/json

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

get

/i2/packages/{number}/label/

GET /api/i2/packages/{number}/label/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": "text"
}

PKG105: Change Shipping Method

post

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

shipping_methodstring · uuidRequired

Unique identifier for the shipping method associated with the new package.

Example: 847b006e-000a-432e-b500-e3f49fa9ddcc

Responses

204

No Content

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

post

/i2/packages/{number}/change-shipping-method/

POST /api/i2/packages/{number}/change-shipping-method/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "shipping_method": "847b006e-000a-432e-b500-e3f49fa9ddcc"
}

No content

PKG106: Split Package

post

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Bodyobject[]

itemsstring[]Required

Number of the package item to be split into a new package.

Example: 2595053219311870-1

shipping_methodstring · uuidOptional

Unique identifier for the shipping method associated with the new package. If not provided, the default shipping method is used.

Example: 847b006e-000a-432e-b500-e3f49fa9ddcc

Responses

204

No Content

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

post

/i2/packages/{number}/split/

POST /api/i2/packages/{number}/split/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

[
  {
    "items": [
      "2595053219311870-1"
    ],
    "shipping_method": "847b006e-000a-432e-b500-e3f49fa9ddcc"
  }
]

No content

PKG107: Reject Package

post

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

itemsstring[]Required

Number of the package item to be rejected.

Example: 2595053219311870-1

reasonstringRequired

Reason for rejecting the package item.

Example: Unsupplied

Responses

204

No Content

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

post

/i2/packages/{number}/reject/

POST /api/i2/packages/{number}/reject/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "items": [
    "2595053219311870-1"
  ],
  "reason": "Unsupplied"
}

No content

PKG108: Release Stock Reservation by Package Item

delete

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

item-numberstringRequired

Unique identifier for the package item.

Example: 2595053219311870-1

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

204

No Content

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

delete

/i2/packages/{number}/reservations/{item-number}

DELETE /api/i2/packages/{number}/reservations/{item-number} HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

PKG109: Refund Package

post

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

reasonstringRequired

Reason for refunding the package.

Example: Unsupplied

refund_invoice_numberstringRequired

Refund invoice number for rejecting the package.

Example: AKINON123456

Responses

204

No Content

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

post

/i2/packages/{number}/refund/

POST /api/i2/packages/{number}/refund/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "reason": "Unsupplied",
  "refund_invoice_number": "AKINON123456"
}

No content

PKG110: Release Stock Reservations by Package Number

delete

Authorizations

AuthorizationstringRequired

Path parameters

numberstringRequired

Unique identifier for the package.

Example: 2595053219311870

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

204

No Content

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

delete

/i2/packages/{number}/reservations/

DELETE /api/i2/packages/{number}/reservations/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

PreviousProducts NextOrders

Last updated 2 days ago

Was this helpful?