Skip to main content
Server path: /base-shipping | Type: Application | PCID required: Yes

Tools

ToolDescription
base_shipping_add_crm_clientAdd or update a CRM client record.
base_shipping_create_packageCreate a courier shipment for an order.
base_shipping_create_package_manualAdd a manually-created shipment to an order (e.g., for a tracking number obtained outside Base).
base_shipping_delete_courier_packageDelete a courier shipment package.
base_shipping_delete_crm_clientDelete a CRM client record.
base_shipping_get_courier_accountsRetrieve courier accounts for a specific courier.
base_shipping_get_courier_fieldsRetrieve the shipment form fields required for a specific courier.
base_shipping_get_courier_servicesRetrieve additional services available for a courier shipment.
base_shipping_get_couriers_listRetrieve the list of available courier integrations.
base_shipping_get_crm_client_dataRetrieve detailed data for a specific CRM client.
base_shipping_get_crm_clientsRetrieve CRM clients. Returns up to 100 per page.
base_shipping_get_labelDownload a shipping label for a package.
base_shipping_get_order_packagesRetrieve shipment packages for an order.
base_shipping_get_package_detailsRetrieve detailed information about a shipment package.
base_shipping_get_protocolDownload a parcel protocol document for packages.

base_shipping_add_crm_client

Add or update a CRM client record. Parameters:
ParameterTypeRequiredDefaultDescription
crm_client_idnumberNoClient ID. Omit to create new, provide to update.
invoice_companystringNoCompany name.
invoice_tax_idstringNoTax identification number.
invoice_fullnamestringNoFull name.
invoice_addressstringNoAddress.
invoice_citystringNoCity.
invoice_postcodestringNoPostal code.
invoice_country_codestringNoCountry code.
emailstringNoEmail address.
phonestringNoPhone number.

base_shipping_create_package

Create a courier shipment for an order. Parameters:
ParameterTypeRequiredDefaultDescription
order_idnumberYesOrder identifier.
courier_codestringYesCourier code (from getCouriersList).
account_idnumberYesCourier account ID (from getCourierAccounts).
fieldsstring[]YesArray of form field objects with ‘id’ and ‘value’ keys (from getCourierFields).
packagesstring[]YesArray of package objects with weight, size_x, size_y, size_z.

base_shipping_create_package_manual

Add a manually-created shipment to an order (e.g., for a tracking number obtained outside Base). Parameters:
ParameterTypeRequiredDefaultDescription
order_idnumberYesOrder identifier.
courier_codestringYesCourier code.
package_numberstringYesTracking number.
pickup_datenumberNoUnix timestamp for pickup date.
return_shipmentbooleanNoWhether this is a return shipment.

base_shipping_delete_courier_package

Delete a courier shipment package. Parameters:
ParameterTypeRequiredDefaultDescription
courier_codestringYesCourier code.
package_idnumberYesPackage/shipment identifier.
package_numberstringNoTracking number (optional alternative to package_id).

base_shipping_delete_crm_client

Delete a CRM client record. Parameters:
ParameterTypeRequiredDefaultDescription
crm_client_idnumberYesClient identifier.

base_shipping_get_courier_accounts

Retrieve courier accounts for a specific courier. Parameters:
ParameterTypeRequiredDefaultDescription
courier_codestringYesCourier code.

base_shipping_get_courier_fields

Retrieve the shipment form fields required for a specific courier. Parameters:
ParameterTypeRequiredDefaultDescription
courier_codestringYesCourier code.

base_shipping_get_courier_services

Retrieve additional services available for a courier shipment. Parameters:
ParameterTypeRequiredDefaultDescription
courier_codestringYesCourier code.
order_idnumberYesOrder identifier.
account_idnumberYesCourier account ID.
fieldsstring[]YesArray of current field values.
packagesstring[]YesArray of package specifications.

base_shipping_get_couriers_list

Retrieve the list of available courier integrations.

base_shipping_get_crm_client_data

Retrieve detailed data for a specific CRM client. Parameters:
ParameterTypeRequiredDefaultDescription
crm_client_idnumberYesClient identifier.

base_shipping_get_crm_clients

Retrieve CRM clients. Returns up to 100 per page. Parameters:
ParameterTypeRequiredDefaultDescription
filter_invoice_companystringNoFilter by company name.
filter_invoice_tax_idstringNoFilter by tax ID.
filter_emailstringNoFilter by email.
filter_phonestringNoFilter by phone.
pagenumberNoPage number (100 clients per page).

base_shipping_get_label

Download a shipping label for a package. Parameters:
ParameterTypeRequiredDefaultDescription
courier_codestringYesCourier code.
package_idnumberYesPackage/shipment identifier.

base_shipping_get_order_packages

Retrieve shipment packages for an order. Parameters:
ParameterTypeRequiredDefaultDescription
order_idnumberYesOrder identifier.

base_shipping_get_package_details

Retrieve detailed information about a shipment package. Parameters:
ParameterTypeRequiredDefaultDescription
package_idnumberYesPackage/shipment identifier.

base_shipping_get_protocol

Download a parcel protocol document for packages. Parameters:
ParameterTypeRequiredDefaultDescription
courier_codestringYesCourier code.
package_idsstring[]YesArray of package/shipment IDs.