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
chevron-right
200

OK

application/json
get
/i2/packages/

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
chevron-right
200

OK

application/json
get
/i2/packages/{number}/items/

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
chevron-right
200

OK

application/json
put
/i2/packages/{number}/

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
chevron-right
200

OK

application/json
get
/i2/packages/{number}/label/

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
post
/i2/packages/{number}/change-shipping-method/

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
post
/i2/packages/{number}/split/

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
post
/i2/packages/{number}/reject/

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
delete
/i2/packages/{number}/reservations/{item-number}

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
post
/i2/packages/{number}/refund/

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
delete
/i2/packages/{number}/reservations/

No content

Last updated

Was this helpful?