/
GET /shipment/search

GET /shipment/search

Get carrier tracking and other information.

Resource URL

Parameters

Name

Data type

Description

Name

Data type

Description

size

number

response data size

item

string

consignment number/tracking number/customer reference

Responses

HTTP Code

Description

Schema

HTTP Code

Description

Schema

200

OK

GetTrackingInformationResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Response Payload Sample

{ "content": [ { "containerType": null, "user": { "id": "string", "firstName": "string", "lastName": "string", "email": "test@test.com", "phone1": "string", "phone2": null, "active": true, "company": { "id": "string", "name": "string", "accountCode": null, "location": 8039, "addressLine1": "string", "addressLine2": "string", "phone1": "string", "phone2": null, "email": "test@test.com", "website": null, "active": true, "primaryContact": { "firstName": "string", "lastName": "string", "email": "test@test.com", "phone1": "string", "phone2": null, "enterCreditCardByResellerCustomer": false }, "billingProfile": { "address1": "string", "address2": "string", "postcodeOrSuburb": "8039", "firstName": "string", "lastName": "string", "phone1": "string", "phone2": null, "email": "test@testc.om", "bankName": null, "bankAccountNumber": null, "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": false, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": false, "reseller": { "id": "62", "name": "string", "accountCode": null, "location": 10742, "addressLine1": "string", "addressLine2": "string", "phone1": "string", "phone2": null, "email": "test@test.com", "website": "www.test.com", "active": true, "primaryContact": null, "billingProfile": { "address1": "string", "address2": "", "postcodeOrSuburb": "string", "firstName": "string", "lastName": "string", "phone1": "string", "phone2": null, "email": "test@test.com", "bankName": "test", "bankAccountNumber": "test", "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": true, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": true, "reseller": null, "logoUrl": "https://storage.googleapis.com/bba-img/62_SHIP2ANYWHERE_LOGO_FULL_BLUE.png", "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": ".ship2anywhere.com.au", "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": false, "useSSCC": false, "emailSender": "no-reply@ship2anywhere.com.au", "emailBcc": "sales@ship2anywhere.com.au", "abnNo": "29 144 845 796 ", "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "logoUrl": null, "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": null, "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": true, "useSSCC": true, "emailSender": null, "emailBcc": null, "abnNo": null, "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "office": { "id": "357", "name": "SHOP TEST COMPANY main office", "code": "KNK30REA", "description": "Automatically created office", "location": 8039, "addressLine1": "68 - 72", "addressLine2": "York", "phone1": "+61423793039", "phone2": "+61423793039", "firstName": "SHOPIFY", "lastName": "TEST", "email": "shierllyq@bbamastro.com", "website": null, "active": true, "currency": "AUD", "weightUnit": "kilograms", "measureUnit": "cm", "parent": null, "company": { "id": "270", "name": "SHOP TEST COMPANY", "accountCode": null, "location": 8039, "addressLine1": "68 - 72", "addressLine2": "York", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "website": null, "active": true, "primaryContact": { "firstName": "SHOPIFY", "lastName": "TEST", "email": "shierllyq@bbamastro.com", "phone1": "+61414692140", "phone2": null, "enterCreditCardByResellerCustomer": false }, "billingProfile": { "address1": "68 - 72", "address2": "York", "postcodeOrSuburb": "8039", "firstName": "SHOPIFY", "lastName": "TEST", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "bankName": null, "bankAccountNumber": null, "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": false, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": false, "reseller": { "id": "62", "name": "Ship2Anywhere", "accountCode": null, "location": 10742, "addressLine1": "530 - 540 Springvale Road", "addressLine2": "Brandon Business Park Level 1, Building 1", "phone1": "1300918372", "phone2": null, "email": "admin@ship2anywhere.com.au", "website": "www.ship2anywhere.com.au", "active": true, "primaryContact": null, "billingProfile": { "address1": "68 - 72 York Street", "address2": "", "postcodeOrSuburb": "18011", "firstName": "S2A Admin", "lastName": "Support", "phone1": "+61 3 7037 6525", "phone2": null, "email": "admin@ship2anywhere.com.au", "bankName": "033-126", "bankAccountNumber": "533970", "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": true, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": true, "reseller": null, "logoUrl": "https://storage.googleapis.com/bba-img/62_SHIP2ANYWHERE_LOGO_FULL_BLUE.png", "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": ".ship2anywhere.com.au", "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": false, "useSSCC": false, "emailSender": "no-reply@ship2anywhere.com.au", "emailBcc": "sales@ship2anywhere.com.au", "abnNo": "29 144 845 796 ", "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "logoUrl": null, "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": null, "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": true, "useSSCC": true, "emailSender": null, "emailBcc": null, "abnNo": null, "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "officeConfiguration": { "emailTrackingToReceiver": true, "satchelOnlyInQuote": false, "ddp": false, "manifesting": false, "scheduledPickup": false, "breakBulkManifesting": true, "timeZone": "Asia/Taipei", "creditLimit": null, "smsNotificationEnabled": false, "containerizationEnabled": false, "crossDockStraightThroughEnabled": false, "jobDeliveredToScanCrossDockShipmentEnabled": false, "crossDockManifestingEnabled": false, "instructionsDocumentEnabled": false, "createPickupJob": false, "thermal": false, "paperlessTradingEnabled": false }, "locationProfile": { "address1": "68 - 72", "address2": "York", "firstName": "SHOPIFY", "lastName": "TEST", "location": 8039, "phone1": "+61423793039", "phone2": "+61423793039", "email": "shierllyq@bbamastro.com" }, "notificationPreferences": { "notifyQuoteAndBook": true, "notifyPendingShipment": true, "notifyReturns": true }, "defaultDimensions": { "enableDefaultDimension": false, "defaultHeight": 0, "defaultLength": 0, "defaultWidth": 0, "defaultWeight": 0 }, "officeType": "warehouse", "geoLocation": { "latitude": -37.814598, "longitude": 144.962073 }, "driverDirectSetting": { "driverDirectEnabled": false, "customerSignature": false, "unattendedPodPicture": false, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": true, "smsNotification": false, "keepPackageUntilRedelivery": false, "pickupFeeEnabled": false, "p2pEnabled": false, "autoJobAssignationEnabled": false, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "returnPackageToDepot": true, "maxCarryOnWeightPerPerson": 0, "maxJob": 0, "shipmentTypes": [] }, "senderCode": null, "receiverCode": null }, "permissionGroup": { "id": "575", "name": "Default group", "description": "Automatically created group", "active": true, "company": { "id": "270", "name": "SHOP TEST COMPANY", "accountCode": null, "location": 8039, "addressLine1": "68 - 72", "addressLine2": "York", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "website": null, "active": true, "primaryContact": { "firstName": "SHOPIFY", "lastName": "TEST", "email": "shierllyq@bbamastro.com", "phone1": "+61414692140", "phone2": null, "enterCreditCardByResellerCustomer": false }, "billingProfile": { "address1": "68 - 72", "address2": "York", "postcodeOrSuburb": "8039", "firstName": "SHOPIFY", "lastName": "TEST", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "bankName": null, "bankAccountNumber": null, "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": false, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": false, "reseller": { "id": "62", "name": "Ship2Anywhere", "accountCode": null, "location": 10742, "addressLine1": "530 - 540 Springvale Road", "addressLine2": "Brandon Business Park Level 1, Building 1", "phone1": "1300918372", "phone2": null, "email": "admin@ship2anywhere.com.au", "website": "www.ship2anywhere.com.au", "active": true, "primaryContact": null, "billingProfile": { "address1": "68 - 72 York Street", "address2": "", "postcodeOrSuburb": "18011", "firstName": "S2A Admin", "lastName": "Support", "phone1": "+61 3 7037 6525", "phone2": null, "email": "admin@ship2anywhere.com.au", "bankName": "033-126", "bankAccountNumber": "533970", "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": true, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": true, "reseller": null, "logoUrl": "https://storage.googleapis.com/bba-img/62_SHIP2ANYWHERE_LOGO_FULL_BLUE.png", "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": ".ship2anywhere.com.au", "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": false, "useSSCC": false, "emailSender": "no-reply@ship2anywhere.com.au", "emailBcc": "sales@ship2anywhere.com.au", "abnNo": "29 144 845 796 ", "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "logoUrl": null, "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": null, "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": true, "useSSCC": true, "emailSender": null, "emailBcc": null, "abnNo": null, "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "roles": [ { "id": "2", "name": "Company admin", "code": "ROLE_COMPANY_ADMIN" }, { "id": "22", "name": "Mobile Warehouse Application", "code": "ROLE_MOBILE_WAREHOUSE" }, { "id": "15", "name": "Reporting graphs", "code": "ROLE_COMPANY_REPORTING_GRAPHS" }, { "id": "16", "name": "Returns", "code": "ROLE_COMPANY_RETURNS" }, { "id": "6", "name": "Inventory management", "code": "ROLE_COMPANY_INVENTORY" }, { "id": "4", "name": "Warehouses", "code": "ROLE_COMPANY_WAREHOUSES" }, { "id": "19", "name": "Packaging Logic", "code": "ROLE_PACKAGING_LOGIC" }, { "id": "5", "name": "Cartonisation / Packaging", "code": "ROLE_COMPANY_PACKAGING" }, { "id": "13", "name": "Pending shipments", "code": "ROLE_COMPANY_PENDING_SHIPMENTS" } ] }, "scanAssignment": null }, "currency": "AUD", "active": true, "bookingDate": "2022-10-06T22:55:38.003+08:00", "deliveredDate": null, "appliedShippingRule": { "shippingRuleId": "633676dac7ec9c0001f129d7", "name": "CHEAP 5 FAST 5", "carrierId": "couriers-please", "serviceId": "P2A", "logo": "https://storage.googleapis.com/bba-img/couriers-please-logo.jpeg", "eta": "0 - 1 day(s)", "transitTimeEarliest": 0, "transitTimeLatest": 24, "amount": 8.230000000000000, "bookingParams": null }, "trackingStatus": "intransit", "quotedShippingCost": { "cost": 9.05, "taxes": 0.82, "sellPrice": 6.58, "driverCommissionFixed": 0.00, "driverCommissionPercentage": 0, "driverCommissionPercentageValue": 0.00, "vat": 0.82, "additionalCharges1": 0.00, "additionalCharges2": 0.00, "additionalCharges": [ { "name": "Hand Unload", "amount": 0, "durationInSeconds": 0 }, { "name": "Demurrage", "amount": 0, "durationInSeconds": 0 }, { "name": "Waiting Time", "amount": 0, "durationInSeconds": 0 } ], "taxPercent": 10, "percentMargin": 25, "percentValueMargin": 1.65, "valueMargin": 0.00, "percentFuel": 0, "percentValueFuel": 0.00, "valueFuel": 0.00, "minPickupFee": 0.00, "surchargeDetails": [], "marginTotal": 1.65, "fuelLevyTotal": 0.00, "surchargeTotal": 0.00, "otherSurchargeTotal": 0.00, "pickupFeeEnabled": false, "driverFee": 0.00, "duties": 0.00 }, "actualShippingCost": { "cost": 9.05, "taxes": 0.82, "sellPrice": 6.58, "driverCommissionFixed": 0.00, "driverCommissionPercentage": 0, "driverCommissionPercentageValue": 0.00, "vat": 0.82, "additionalCharges1": 0.00, "additionalCharges2": 0.00, "additionalCharges": [ { "name": "Hand Unload", "amount": 0, "durationInSeconds": 0 }, { "name": "Demurrage", "amount": 0, "durationInSeconds": 0 }, { "name": "Waiting Time", "amount": 0, "durationInSeconds": 0 } ], "taxPercent": 10, "percentMargin": 25, "percentValueMargin": 1.65, "valueMargin": 0.00, "percentFuel": 0, "percentValueFuel": 0.00, "valueFuel": 0.00, "minPickupFee": 0.00, "surchargeDetails": [], "marginTotal": 1.65, "fuelLevyTotal": 0.00, "surchargeTotal": 0.00, "otherSurchargeTotal": 0.00, "pickupFeeEnabled": false, "driverFee": 0.00, "duties": 0.00 }, "wmsReference": null, "deliveryDate": null, "marketplaceId": null, "manifestId": "633eec6ae0bc80000140571d", "bbaReferenceNumber": "000000044312", "ioss": null, "shippingCost": { "cost": 9.05, "taxes": 0.82, "sellPrice": 6.58, "driverCommissionFixed": 0.00, "driverCommissionPercentage": 0, "driverCommissionPercentageValue": 0.00, "vat": 0.82, "additionalCharges1": 0.00, "additionalCharges2": 0.00, "additionalCharges": [ { "name": "Hand Unload", "amount": 0, "durationInSeconds": 0 }, { "name": "Demurrage", "amount": 0, "durationInSeconds": 0 }, { "name": "Waiting Time", "amount": 0, "durationInSeconds": 0 } ], "taxPercent": 10, "percentMargin": 25, "percentValueMargin": 1.65, "valueMargin": 0.00, "percentFuel": 0, "percentValueFuel": 0.00, "valueFuel": 0.00, "minPickupFee": 0.00, "surchargeDetails": [], "marginTotal": 1.65, "fuelLevyTotal": 0.00, "surchargeTotal": 0.00, "otherSurchargeTotal": 0.00, "pickupFeeEnabled": false, "driverFee": 0.00, "duties": 0.00 }, "sscc": null, "lastModifiedDate": "2022-10-06T22:55:39.737+08:00", "purchasedDate": null, "totalDeadWeight": 1.00, "totalCubicWeight": 0.00, "timeBasedRateDetail": null, "containerName": null, "dangerousGoods": false, "description": null, "handUnload": false, "containerId": null, "handUnloadDuration": null, "demurrageDuration": null, "shippingMethod": null, "serviceProfile": { "id": "5f771b7733b463000196ede7", "carrierProfile": { "id": "5f3f80edd7299e000129b2ba", "name": "Couriers Please", "email": "admin@ship2anywhere.com", "website": null, "logoUrl": "https://storage.googleapis.com/bba-img/couriers-please-logo.jpeg", "phone1": "1300918372", "phone2": null, "address1": "530 - 540 Springvale Road", "address2": null, "active": true, "carrierId": "couriers-please", "companyId": 62, "locationId": 10742, "primaryContact": { "firstName": "S2A Admin", "lastName": "Support", "email": "admin@ship2anywhere.com", "phone1": "1300918372", "phone2": null, "enterCreditCardByResellerCustomer": false }, "settings": [ { "name": "Account Number", "description": "Provided by Couriers Please", "value": "\"112960935\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Customer Identifier", "description": "Provided by Couriers Please", "value": "\"ASMD\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Consignment Range - Min", "description": "Provided by Couriers Please", "value": "\"0631764\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Consignment Range - Max", "description": "Provided by Couriers Please", "value": "\"9999999\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "FTP URL", "description": "Provided by Couriers Please", "value": "\"ftp.couriersplease.com.au\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "FTP Username", "description": "Provided by Couriers Please", "value": "\"ship\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "FTP Password", "description": "Provided by Couriers Please", "value": "\"anywhere\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "FTP Port", "description": "Provided by Couriers Please", "value": "21", "valueList": [], "valueType": "number", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "FTP Manifest Directory", "description": "Provided by Couriers Please", "value": "\"/incoming\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "FTP Tracking Directory", "description": "Provided by Couriers Please", "value": "\"/outgoing\"", "valueList": [], "valueType": "string", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Enable Dangerous Goods", "description": "Default: Enabled; Options: Enabled / Disabled", "value": "true", "valueList": [], "valueType": "boolean", "option": { "vtrue": "Enabled", "vfalse": "Disabled" }, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Enable PO Box Delivery", "description": "Default: Enabled; Options: Enabled / Disabled", "value": "false", "valueList": [], "valueType": "boolean", "option": { "vtrue": "Enabled", "vfalse": "Disabled" }, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Enable Tail Gate", "description": "Default: Enabled; Options: Enabled / Disabled", "value": "true", "valueList": [], "valueType": "boolean", "option": { "vtrue": "Enabled", "vfalse": "Disabled" }, "mandatory": true, "prerequisiteSettings": [] } ], "productSource": "internal", "quoteGeneratedByCarrierApi": false, "addressValidationExternal": false, "shipmentGeneratedByCarrierApi": false, "networkEffects": [], "accountingSetting": { "autoReconcile": false } }, "carrierAccountCode": "1001001", "carrierId": "couriers-please", "serviceId": "P2A", "name": "Couriers Please - P2A - 2Kg Parcel ATL - HR1", "displayName": null, "active": true, "currency": "AUD", "companyId": 62, "networkEffect": null, "settings": [ { "name": "Account Number", "description": "Provided by Couriers Please", "value": "\"113137772\"", "valueList": [], "valueType": "string", "option": null, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Customer Identifier", "description": "Provided by Couriers Please", "value": "\"B5VW\"", "valueList": [], "valueType": "string", "option": null, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Consignment Range - Min", "description": "Provided by Couriers Please", "value": "\"0000000\"", "valueList": [], "valueType": "string", "option": null, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Consignment Range - Max", "description": "Provided by Couriers Please", "value": "\"9999999\"", "valueList": [], "valueType": "string", "option": null, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Authority to Leave Only", "description": "Set shipments authority to leave to true.", "value": "true", "valueList": [], "valueType": "boolean", "option": { "vtrue": "Enabled", "vfalse": "Disabled" }, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Enable Dangerous Goods", "description": "Default: Enabled; Options: Enabled / Disabled", "value": "true", "valueList": [], "valueType": "boolean", "option": { "vtrue": "Enabled", "vfalse": "Disabled" }, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Enable PO Box Delivery", "description": "Default: Enabled; Options: Enabled / Disabled", "value": "false", "valueList": [], "valueType": "boolean", "option": { "vtrue": "Enabled", "vfalse": "Disabled" }, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Enable Tail Gate", "description": "Default: Enabled; Options: Enabled / Disabled", "value": "true", "valueList": [], "valueType": "boolean", "option": { "vtrue": "Enabled", "vfalse": "Disabled" }, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Warranty Free Coverage", "description": "Provided by Couriers Please", "value": "0", "valueList": [], "valueType": "number", "option": null, "mandatory": false, "prerequisiteSettings": [] }, { "name": "Oversize Length per Item", "description": "Provided by Couriers Please", "value": "30.00", "valueList": [], "valueType": "number", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Oversize Dead Weight per Item", "description": "Provided by Couriers Please", "value": "30.00", "valueList": [], "valueType": "number", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Oversize Cubic Weight per Item", "description": "Provided by Couriers Please", "value": "30.00", "valueList": [], "valueType": "number", "option": null, "mandatory": true, "prerequisiteSettings": [] }, { "name": "Oversize Cubic Weight per Consignment", "description": "Provided by Couriers Please", "value": "30.00", "valueList": [], "valueType": "number", "option": null, "mandatory": true, "prerequisiteSettings": [] } ], "fuelLevy": { "id": "5f771b7733b463000196edaa", "carrierId": "couriers-please", "serviceId": "P2A", "name": "Couriers Please P2A fuel levy", "percentage": 10, "fixed": 1, "active": true }, "quoteGeneratedByCarrierApi": false, "carrierData": {}, "detailHidden": false, "bbaProfileId": null, "serviceName": "Couriers Please - (A) Road Express", "clientServiceProfiles": [ { "id": "5fc844bee89e460001f329a6", "carrierProfile": null, "serviceProfile": null, "name": "S2A - CP P2A 2KG Parcel ATL - HR1 - CONN (ADHOC)", "companyId": 62, "companies": [ "64" ], "enabled": true, "driverDirectEnabled": false, "customerSignature": true, "unattendedPodPicture": true, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "p2pEnabled": false, "autoJobAssignationEnabled": true, "jobSplittingEnabled": true, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "returnPackageToDepot": true, "maxCarryOnWeightPerPerson": 0, "marginMinValue": 0.5, "marginPercent": 35, "currency": "AUD", "offices": null, "crossDockEnabled": false, "maxJob": 0, "pickupFeeEnabled": false, "minPickupFee": 0, "shipmentTypes": [ "regular", "returns" ], "firstMileDriverDirectConfig": { "enabled": false, "customerSignature": false, "unattendedPodPicture": false, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "returnPackageToDepot": false, "p2pEnabled": false, "autoJobAssignationEnabled": false, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "maxCarryOnWeightPerPerson": 0, "maxJob": 0, "shipmentTypes": [ "regular", "returns" ] }, "lineHaulDriverDirectConfig": { "enabled": false, "customerSignature": false, "unattendedPodPicture": false, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "returnPackageToDepot": false, "p2pEnabled": false, "autoJobAssignationEnabled": false, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "maxCarryOnWeightPerPerson": 0, "maxJob": 0, "shipmentTypes": [ "regular", "returns" ] }, "lastMileDriverDirectConfig": { "enabled": false, "customerSignature": false, "unattendedPodPicture": false, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "returnPackageToDepot": false, "p2pEnabled": false, "autoJobAssignationEnabled": false, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "maxCarryOnWeightPerPerson": 0, "maxJob": 0, "shipmentTypes": [ "regular", "returns" ] }, "directCarrierBillsServiceEnabled": false }, { "id": "5f7ac55c378b730001670d2a", "carrierProfile": null, "serviceProfile": null, "name": "S2A - CP P2A 2KG Parcel ATL - HR1 - CONN (LITE)", "companyId": 62, "companies": [ "500", "501", "502", "506", "507", "508", "509", "510", "511", "513", "515", "516", "517", "518", "520", "400", "521", "401", "403", "405", "406", "528", "408", "409", "530", "410", "531", "532", "412", "533", "413", "414", "535", "415", "536", "416", "537", "417", "418", "539", "419", "420", "541", "300", "543", "423", "544", "424", "545", "425", "546", "426", "306", "427", "548", "307", "428", "308", "309", "551", "310", "552", "432", "555", "435", "556", "315", "436", "557", "316", "437", "558", "438", "318", "439", "319", "560", "440", "561", "320", "562", "200", "321", "201", "322", "443", "564", "202", "444", "323", "565", "203", "445", "566", "204", "446", "325", "567", "326", "447", "568", "206", "448", "569", "207", "328", "449", "329", "209", "450", "330", "451", "210", "452", "331", "211", "332", "453", "212", "454", "333", "334", "455", "214", "335", "215", "336", "457", "216", "337", "458", "338", "217", "459", "339", "218", "219", "460", "340", "461", "220", "462", "221", "342", "463", "343", "464", "223", "345", "224", "466", "225", "467", "226", "468", "227", "469", "349", "228", "229", "350", "471", "351", "230", "472", "231", "352", "232", "354", "475", "234", "355", "476", "477", "235", "356", "478", "357", "479", "237", "359", "239", "480", "481", "360", "361", "240", "483", "242", "363", "484", "243", "364", "244", "365", "486", "245", "487", "246", "488", "247", "489", "248", "369", "491", "250", "492", "251", "372", "493", "252", "373", "374", "375", "496", "255", "497", "499", "378", "381", "261", "382", "263", "264", "265", "266", "387", "389", "269", "270", "391", "271", "393", "272", "394", "273", "395", "274", "396", "275", "276", "397", "277", "278", "399", "279", "280", "281", "282", "283", "284", "286", "288", "169", "62", "65", "66", "68", "69", "290", "170", "291", "292", "171", "172", "173", "174", "175", "296", "176", "297", "177", "298", "299", "178", "179", "70", "71", "76", "78", "181", "182", "183", "184", "185", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199" ], "enabled": true, "driverDirectEnabled": false, "customerSignature": true, "unattendedPodPicture": true, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "p2pEnabled": false, "autoJobAssignationEnabled": true, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "returnPackageToDepot": true, "maxCarryOnWeightPerPerson": 0, "marginMinValue": 0, "marginPercent": 25, "currency": "AUD", "offices": null, "crossDockEnabled": false, "maxJob": 0, "pickupFeeEnabled": false, "minPickupFee": 0, "shipmentTypes": [ "regular", "returns" ], "firstMileDriverDirectConfig": { "enabled": false, "customerSignature": false, "unattendedPodPicture": false, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "returnPackageToDepot": false, "p2pEnabled": false, "autoJobAssignationEnabled": false, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "maxCarryOnWeightPerPerson": 0, "maxJob": 0, "shipmentTypes": [ "regular", "returns" ] }, "lineHaulDriverDirectConfig": { "enabled": false, "customerSignature": false, "unattendedPodPicture": false, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "returnPackageToDepot": false, "p2pEnabled": false, "autoJobAssignationEnabled": false, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "maxCarryOnWeightPerPerson": 0, "maxJob": 0, "shipmentTypes": [ "regular", "returns" ] }, "lastMileDriverDirectConfig": { "enabled": false, "customerSignature": false, "unattendedPodPicture": false, "callCustomer": false, "requiredPackageScanning": false, "emailNotification": false, "smsNotification": false, "keepPackageUntilRedelivery": false, "returnPackageToDepot": false, "p2pEnabled": false, "autoJobAssignationEnabled": false, "jobSplittingEnabled": false, "driverCommissionFixed": 0, "driverCommissionPercentage": 0, "maxCarryOnWeightPerPerson": 0, "maxJob": 0, "shipmentTypes": [ "regular", "returns" ] }, "directCarrierBillsServiceEnabled": false } ], "fuelLevyEnabled": false, "cubicConversionFactor": 0, "overrideAccountingSetting": false, "accountingSetting": { "autoReconcile": false }, "connected": true, "networkSharedTo": [ "62", "19" ], "profileSettings": [], "directDriver": false, "hidden": false, "hasRate": true, "hasDistanceRate": false, "hasWeightRate": false, "hasItemRate": true, "hasTimeRate": false, "insuranceAmount": 1000, "logoUrl": null, "networkEffectEnabled": false }, "serviceDetails": { "carrierName": "Couriers Please", "serviceName": "P2A - 2Kg Parcel ATL", "logo": "https://storage.googleapis.com/bba-img/couriers-please-logo.jpeg" }, "createdDate": "2022-10-06T22:55:33.545+08:00", "sourceAddress": { "firstName": "TEST TEST", "lastName": "DO NOT PICKUP", "company": "TEST TEST TEST DO NOT PICKUP", "addressLine1": "TEST TEST TEST DO NOT PICKUP", "addressLine2": null, "phone": "+61455729236", "email": "cedericaeronb@bbamastro.com", "location": { "id": 8039, "name": "Chadstone", "code": "3148", "latitude": null, "longitude": null, "zoneId": null, "country": { "name": "Australia", "code": "AU" }, "state": { "name": "Victoria", "code": "VIC" } } }, "company": { "id": "270", "name": "SHOP TEST COMPANY", "accountCode": null, "location": 8039, "addressLine1": "68 - 72", "addressLine2": "York", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "website": null, "active": true, "primaryContact": { "firstName": "SHOPIFY", "lastName": "TEST", "email": "shierllyq@bbamastro.com", "phone1": "+61414692140", "phone2": null, "enterCreditCardByResellerCustomer": false }, "billingProfile": { "address1": "68 - 72", "address2": "York", "postcodeOrSuburb": "8039", "firstName": "SHOPIFY", "lastName": "TEST", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "bankName": null, "bankAccountNumber": null, "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": false, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": false, "reseller": { "id": "62", "name": "Ship2Anywhere", "accountCode": null, "location": 10742, "addressLine1": "530 - 540 Springvale Road", "addressLine2": "Brandon Business Park Level 1, Building 1", "phone1": "1300918372", "phone2": null, "email": "admin@ship2anywhere.com.au", "website": "www.ship2anywhere.com.au", "active": true, "primaryContact": null, "billingProfile": { "address1": "68 - 72 York Street", "address2": "", "postcodeOrSuburb": "18011", "firstName": "S2A Admin", "lastName": "Support", "phone1": "+61 3 7037 6525", "phone2": null, "email": "admin@ship2anywhere.com.au", "bankName": "033-126", "bankAccountNumber": "533970", "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": true, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": true, "reseller": null, "logoUrl": "https://storage.googleapis.com/bba-img/62_SHIP2ANYWHERE_LOGO_FULL_BLUE.png", "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": ".ship2anywhere.com.au", "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": false, "useSSCC": false, "emailSender": "no-reply@ship2anywhere.com.au", "emailBcc": "sales@ship2anywhere.com.au", "abnNo": "29 144 845 796 ", "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "logoUrl": null, "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": null, "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": true, "useSSCC": true, "emailSender": null, "emailBcc": null, "abnNo": null, "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "destinationAddress": { "firstName": "TEST TEST TEST", "lastName": "DO NOT PICKUP", "company": "TEST_TEST_TEST_DO_NOT_PICKUP", "addressLine1": "TEST TEST TEST DO NOT PICKUP", "addressLine2": null, "phone": "+61412345678", "email": "cedericaeronb@bbamastro.com", "location": { "id": 14109, "name": "Melbourne", "code": "3000", "latitude": null, "longitude": null, "zoneId": null, "country": { "name": "Australia", "code": "AU" }, "state": { "name": "Victoria", "code": "VIC" } } }, "consignmentId": "CPB5VWZ00001748", "customerReferences": [ "TEST TEST TEST DO NOT PICKUP" ], "items": [], "history": [ { "user": "TEST TEST", "date": "2022-10-06T22:55:35.739+0800", "details": "Created in dashboard.", "change": "CREATED" }, { "user": "TEST TEST", "date": "2022-10-06T22:55:35.739+0800", "details": "Booked Couriers Please - P2A - 2Kg Parcel ATL - HR1 shipment", "change": "BOOKED" }, { "user": "TEST TEST", "date": "2022-10-06T22:55:38.580+0800", "details": "Shipment tracking status was updated to INTRANSIT", "change": "TRACKING" } ], "crossDockTrackingStatus": null, "fragile": false, "taxStatus": "private", "carrierOrderId": null, "withheld": false, "returnAuthorityNumber": null, "consolidation": null, "originalConsignmentId": null, "scannedDate": null, "scannedBy": null, "invoiceDetails": null, "invoiceId": null, "lastDocumentPrintedTime": "2022-10-06T22:55:39.736+08:00", "originalShipmentId": null, "manifestedDate": "2022-10-06T22:55:38.198+08:00", "packagePerSscc": [ { "sscc": "(00)093506300000463111", "length": 1, "width": 1, "height": 1, "weight": 1, "contentWeight": 1, "cubicWeight": 0, "cubicMeter": 0, "totalDeadWeight": 1, "totalCubicWeight": 0.0002500000000000000, "quantity": 1, "measureUnit": "cm", "weightUnit": "kilograms", "packagingId": null, "index": 0, "labelStartPage": 1, "labelEndPage": 1, "name": null, "externalId": null, "packageId": null, "customerReference": null, "createdDate": "1970-01-01T00:00:00.000+0000", "ssccList": [ "(00)093506300000463111" ], "packageType": null, "atlNumber": null, "barcodeText": null, "logisticsUnitType": null, "ssccScanned": null, "valid": true } ], "paymentType": "sweep", "pickupDetails": { "pickupTimezone": "+11:00", "pickupDate": "2022-10-07T06:00:00.202", "pickupEarliestTime": "09:00", "pickupLatestTime": null, "asap": true }, "lastMileCarrierBookingOptions": {}, "carrierBookingOptions": {}, "reasonForShipping": "sale", "specialInstructions": "TEST TEST TEST DO NOT PICKUP", "amount": 8.23, "breakBulkDetails": null, "firstMileCarrierBookingOptions": {}, "packaging": "1.00 cm x 1.00 cm x 1.00 cm", "office": { "currency": "AUD", "active": true, "officeConfiguration": { "emailTrackingToReceiver": true, "satchelOnlyInQuote": false, "ddp": false, "manifesting": false, "scheduledPickup": false, "breakBulkManifesting": true, "timeZone": "Asia/Taipei", "creditLimit": null, "smsNotificationEnabled": false, "containerizationEnabled": false, "crossDockStraightThroughEnabled": false, "jobDeliveredToScanCrossDockShipmentEnabled": false, "crossDockManifestingEnabled": false, "instructionsDocumentEnabled": false, "createPickupJob": false, "thermal": false, "paperlessTradingEnabled": false }, "notificationPreferences": { "notifyQuoteAndBook": true, "notifyPendingShipment": true, "notifyReturns": true }, "description": "Automatically created office", "firstName": "SHOPIFY", "lastName": "TEST", "company": { "id": "270", "name": "SHOP TEST COMPANY", "accountCode": null, "location": 8039, "addressLine1": "68 - 72", "addressLine2": "York", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "website": null, "active": true, "primaryContact": { "firstName": "SHOPIFY", "lastName": "TEST", "email": "shierllyq@bbamastro.com", "phone1": "+61414692140", "phone2": null, "enterCreditCardByResellerCustomer": false }, "billingProfile": { "address1": "68 - 72", "address2": "York", "postcodeOrSuburb": "8039", "firstName": "SHOPIFY", "lastName": "TEST", "phone1": "+61414692140", "phone2": null, "email": "shierllyq@bbamastro.com", "bankName": null, "bankAccountNumber": null, "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": false, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": false, "reseller": { "id": "62", "name": "Ship2Anywhere", "accountCode": null, "location": 10742, "addressLine1": "530 - 540 Springvale Road", "addressLine2": "Brandon Business Park Level 1, Building 1", "phone1": "1300918372", "phone2": null, "email": "admin@ship2anywhere.com.au", "website": "www.ship2anywhere.com.au", "active": true, "primaryContact": null, "billingProfile": { "address1": "68 - 72 York Street", "address2": "", "postcodeOrSuburb": "18011", "firstName": "S2A Admin", "lastName": "Support", "phone1": "+61 3 7037 6525", "phone2": null, "email": "admin@ship2anywhere.com.au", "bankName": "033-126", "bankAccountNumber": "533970", "onAccount": false, "adHocPayment": true, "sweepPayment": true, "creditEnabled": true }, "offices": null, "enableServiceSharing": true, "networkEnabled": false, "smsNotificationEnabled": false, "isReseller": true, "reseller": null, "logoUrl": "https://storage.googleapis.com/bba-img/62_SHIP2ANYWHERE_LOGO_FULL_BLUE.png", "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": ".ship2anywhere.com.au", "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": false, "useSSCC": false, "emailSender": "no-reply@ship2anywhere.com.au", "emailBcc": "sales@ship2anywhere.com.au", "abnNo": "29 144 845 796 ", "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "logoUrl": null, "customerCarrierAccountCode": null, "ftpCarrierDirectory": null, "domain": null, "headerLogo": null, "footerLogo": null, "uniqueSSCCPerPackage": true, "useSSCC": true, "emailSender": null, "emailBcc": null, "abnNo": null, "warrantyEnabled": false, "ioss": null, "trackingCompanyName": null }, "addressLine1": "68 - 72", "addressLine2": "York", "phone1": "+61423793039", "email": "shierllyq@bbamastro.com", "measureUnit": "cm", "weightUnit": "kilograms", "code": "KNK30REA", "phone2": "+61423793039", "website": null, "locationProfile": { "address1": "68 - 72", "address2": "York", "locationDetails": { "latitude": -37.8819831, "longitude": 145.0989646, "code": "3148", "zoneId": "Australia/Melbourne", "name": "Chadstone", "id": 8039, "state": { "name": "Victoria", "code": "VIC" }, "country": { "name": "Australia", "code": "AU" } }, "firstName": "SHOPIFY", "lastName": "TEST", "phone1": "+61423793039", "email": "shierllyq@bbamastro.com", "phone2": "+61423793039", "location": 8039 }, "name": "SHOP TEST COMPANY main office", "parent": null, "location": { "id": 8039, "name": "Chadstone", "code": "3148", "latitude": -37.8819831, "longitude": 145.0989646, "zoneId": "Australia/Melbourne", "country": { "name": "Australia", "code": "AU" }, "state": { "name": "Victoria", "code": "VIC" } }, "id": "357" }, "bookingStatus": "processed", "trackingNumber": "CPB5VWZ000017483403", "previousTrackingStatus": "documentationprepared", "podUrl": null, "paymentResponse": null, "officeTransitionHistory": [ "2022-10-06 14:55:33 Created on SHOP TEST COMPANY main office branch." ], "receiptEmail": "cedericaeronb@bbamastro.com", "paymentDetails": { "paymentGateway": "stripe", "paymentMethodId": "pm_1LnQRKGVUeYa2NgGWn0KTfUU", "paymentId": "stripe_553", "receiptNumber": null, "cardDetails": { "cardBrand": "visa", "cardLast4Digit": "1845", "cardExpiryMonth": 4, "cardExpiryYear": 2024 }, "sweepCreditCard": false, "billedByCarrier": false, "useReceiverName": false }, "packDescAutoPopulate": true, "trolleyRequired": false, "accompaniedDelivery": false, "residentialPickup": false, "residentialDelivery": false, "validationResult": { "messages": [], "valid": true }, "notifySender": false, "readyForProcess": true, "ssccLinked": "N/A", "manifestNo": 50718, "job": null, "carrierConfiguration": { "carrierId": "couriers-please", "carrierName": "Couriers Please", "logoUrl": "https://storage.googleapis.com/bba-img/couriers-please-logo.jpeg", "hasSurcharge": true, "generateSSCC": true, "trackingEventUpdateDisabled": false, "allowedInternationalShipment": true, "hasCarrierBookingOptions": false, "hasConsignmentNote": false }, "billed": false, "toBeProcessed": true, "notifyReceiver": true, "poBox": false, "tailGate": false, "unattendedDelivery": false, "clientPresent": false, "packages": [ { "index": 0, "cubicWeight": 0, "atlNumber": null, "logisticsUnitType": null, "totalDeadWeight": 1.00, "totalCubicWeight": 0.00, "customerReference": null, "weight": 1.00, "createdDate": "1970-01-01T08:00:00+08:00", "measureUnit": "cm", "height": 1.00, "quantity": 1, "weightUnit": "kilograms", "contentWeight": 1.00, "packageId": null, "ssccList": [ "(00)093506300000463111" ], "width": 1.00, "cubicMeter": 0.00, "ssccScanned": null, "packagingId": null, "length": 1.00, "name": null } ], "id": "633eec69e0bc80000140571b" } ], "pageable": { "sort": { "unsorted": false, "sorted": true, "empty": false }, "pageSize": 20, "pageNumber": 0, "offset": 0, "paged": true, "unpaged": false }, "totalElements": 1, "totalPages": 1, "last": true, "first": true, "sort": { "unsorted": false, "sorted": true, "empty": false }, "numberOfElements": 1, "size": 20, "number": 0, "empty": false }

Please refer to the Additional Reference section for more information on BBA Integration API objects.

 

Related content

GET /shipment
GET /shipment
More like this
POST /quote
POST /quote
More like this
POST /shipment
POST /shipment
More like this
PUT /shipment/{shipmentId}/tracking?trackingStatus={trackingStatus}
PUT /shipment/{shipmentId}/tracking?trackingStatus={trackingStatus}
More like this
GET /{shipmentId}/tracking
GET /{shipmentId}/tracking
More like this
PUT /shipment/label
PUT /shipment/label
More like this