API Integration
SAPIENT
sapientproduction-ready
No description available.
ShippingRatingPickup
Connection Requirements
| Field | Type | Required |
|---|---|---|
| client_id | string | |
| client_secret | string | |
| shipping_account_id | string | |
| sapient_carrier_code | string | |
| account_country_code | string | |
| metadata | object | |
| config | object | |
| services | list |
Carrier Configuration
| Field | Type |
|---|---|
| service_level | string |
| shipping_options | list |
| shipping_services | list |
Available Services
| Service Name | Service Code |
|---|---|
| BF1 | sapient_royal_mail_hm_forces_mail |
| BF2 | sapient_royal_mail_hm_forces_signed_for |
| BF7 | sapient_royal_mail_hm_forces_special_delivery_500 |
| BF8 | sapient_royal_mail_hm_forces_special_delivery_1000 |
| BF9 | sapient_royal_mail_hm_forces_special_delivery_2500 |
| BG1 | sapient_royal_mail_international_business_personal_correspondence_max_sort_residue_ll |
| BG2 | sapient_royal_mail_international_business_mail_ll_max_sort_residue_standard |
| BP1 | sapient_royal_mail_international_business_personal_correspondence_max_sort_residue_l |
| BP2 | sapient_royal_mail_international_business_mail_l_max_sort_residue_standard |
| BPI | sapient_royal_mail_international_business_printed_matter_packet |
| BPL1 | sapient_royal_mail_1st_class |
| BPL2 | sapient_royal_mail_2nd_class |
| BPR1 | sapient_royal_mail_1st_class_signed_for |
| BPR2 | sapient_royal_mail_2nd_class_signed_for |
| BXB | sapient_royal_mail_international_business_parcel_priority_country_priced_boxable |
| BXC | sapient_royal_mail_international_business_parcel_tracked_country_priced_boxable_extra_comp |
| BXD | sapient_royal_mail_international_business_parcel_priority_country_priced_boxable_ddp |
| BXE | sapient_royal_mail_international_business_parcel_tracked_country_priced_boxable_ddp |
| BXF | sapient_royal_mail_international_business_parcel_tracked_country_priced_boxable |
| CRL1 | sapient_royal_mail_24_standard_signed_for_parcel_daily_rate_service |
| CRL2 | sapient_royal_mail_48_standard_signed_for_parcel_daily_rate_service |
| DE4 | sapient_royal_mail_international_business_parcels_zero_sort_priority |
| DE6 | sapient_royal_mail_international_business_parcels_zero_sort_priority_DE |
| DEA | sapient_royal_mail_de_import_standard_24_parcel |
| DEB | sapient_royal_mail_de_import_standard_24_parcel_DE |
| DEC | sapient_royal_mail_de_import_standard_24_ll |
| DED | sapient_royal_mail_de_import_standard_48_ll |
| DEE | sapient_royal_mail_de_import_to_eu_tracked_signed_ll |
| DEG | sapient_royal_mail_de_import_to_eu_max_sort_ll |
| DEI | sapient_royal_mail_de_import_to_eu_tracked_parcel |
| DEJ | sapient_royal_mail_de_import_to_eu_tracked_signed_parcel |
| DEK | sapient_royal_mail_de_import_to_eu_tracked_high_vol_ll |
| DEM | sapient_royal_mail_de_import_to_eu_max_sort_parcel |
| DG4 | sapient_royal_mail_international_business_mail_ll_country_priced_priority |
| DP3 | sapient_royal_mail_international_business_personal_correspondence_l_priority_untracked |
| DP6 | sapient_royal_mail_international_business_mail_ll_country_sort_priority |
| DW1 | sapient_royal_mail_international_business_parcels |
| ETA | sapient_royal_mail_international_business_parcels_tracked_country_priced_extra_territorial_office_of_exchange |
| ETB | sapient_royal_mail_international_business_parcels_tracked_signed_country_priced_extra_territorial_office_of_exchange |
| ETC | sapient_royal_mail_international_business_parcels_zero_sort_priority_extra_territorial_office_of_exchange |
| ETD | sapient_royal_mail_international_business_mail_tracked_ll_country_priced_extra_territorial_office_of_exchange |
| ETE | sapient_royal_mail_international_business_mail_tracked_signed_ll_country_priced_extra_territorial_office_of_exchange |
| ETF | sapient_royal_mail_international_business_mail_ll_country_priced_priority_extra_territorial_office_of_exchange |
| ETG | sapient_royal_mail_international_tracked_parcels_0_30kg_extra_territorial_office_of_exchange_e |
| ETH | sapient_royal_mail_international_tracked_parcels_0_30kg_extra_comp_extra_territorial_office_of_exchange_e |
| ETI | sapient_royal_mail_international_tracked_parcels_0_30kg_extra_territorial_office_of_exchange_c |
| ETJ | sapient_royal_mail_international_tracked_parcels_0_30kg_extra_comp_extra_territorial_office_of_exchange_c |
| ETK | sapient_royal_mail_international_business_personal_correspondence_l_priority_untracked_extra_territorial_office_of_exchange |
| ETL | sapient_royal_mail_international_business_personal_correspondence_l_tracked_high_vol_country_priced_extra_territorial_office_of_exchange |
| ETM | sapient_royal_mail_international_business_personal_correspondence_l_tracked_signed_high_vol_country_priced_extra_territorial_office_of_exchange |
| ETN | sapient_royal_mail_international_business_personal_correspondence_signed_l_high_vol_country_priced_extra_territorial_office_of_exchange |
| ETO | sapient_royal_mail_international_business_personal_correspondence_ll_country_sort_priority_extra_territorial_office_of_exchange |
| ETP | sapient_royal_mail_international_business_personal_correspondence_tracked_ll_high_vol_extra_comp_country_priced_extra_territorial_office_of_exchange |
| ETQ | sapient_royal_mail_international_business_personal_correspondence_tracked_signed_ll_high_vol_extra_comp_country_priced_extra_territorial_office_of_exchange |
| ETR | sapient_royal_mail_international_business_personal_correspondence_signed_ll_extra_compensation_country_priced_extra_territorial_office_of_exchange |
| FS1 | sapient_royal_mail_24_standard_signed_for_large_letter_flat_rate_service |
| FS2 | sapient_royal_mail_48_standard_signed_for_large_letter_flat_rate_service |
| FS7 | sapient_royal_mail_24_presorted_ll |
| FS8 | sapient_royal_mail_48_presorted_ll |
| HVB | sapient_royal_mail_international_tracked_parcels_0_30kg |
| HVD | sapient_royal_mail_international_business_tracked_express_npc |
| HVE | sapient_royal_mail_international_tracked_parcels_0_30kg_extra_comp |
| HVK | sapient_royal_mail_international_tracked_parcels_0_30kg_c_prio |
| HVL | sapient_royal_mail_international_tracked_parcels_0_30kg_xcomp_c_prio |
| IE1 | sapient_royal_mail_international_business_parcels_zone_sort_priority_service |
| IG1 | sapient_royal_mail_international_business_mail_large_letter_zone_sort_priority |
| IG4 | sapient_royal_mail_international_business_mail_large_letter_zone_sort_priority_machine |
| IP1 | sapient_royal_mail_international_business_mail_letters_zone_sort_priority |
| ITA | sapient_royal_mail_import_de_tracked_returns_24 |
| ITB | sapient_royal_mail_import_de_tracked_returns_48 |
| ITC | sapient_royal_mail_import_de_tracked_24_letter_boxable_high_volume |
| ITD | sapient_royal_mail_import_de_tracked_48_letter_boxable_high_volume |
| ITE | sapient_royal_mail_import_de_tracked_48_letter_boxable |
| ITF | sapient_royal_mail_import_de_tracked_24_letter_boxable |
| ITL | sapient_royal_mail_import_de_tracked_48_high_volume |
| ITM | sapient_royal_mail_import_de_tracked_24_high_volume |
| ITN | sapient_royal_mail_import_de_tracked_24 |
| ITR | sapient_royal_mail_de_import_to_eu_signed_parcel |
| ITS | sapient_royal_mail_import_de_tracked_48 |
| MB1 | sapient_royal_mail_international_business_parcels_print_direct_priority |
| MB2 | sapient_royal_mail_international_business_parcels_print_direct_standard |
| MP0 | sapient_royal_mail_international_business_parcels_signed_extra_compensation_country_priced |
| MP1 | sapient_royal_mail_international_business_parcels_tracked_zone_sort |
| MP4 | sapient_royal_mail_international_business_parcels_tracked_extra_comp_zone_sort |
| MP5 | sapient_royal_mail_international_business_parcels_signed_zone_sort |
| MP6 | sapient_royal_mail_international_business_parcels_signed_extra_compensation_zone_sort |
| MP7 | sapient_royal_mail_international_business_parcels_tracked_country_priced |
| MP8 | sapient_royal_mail_international_business_parcels_tracked_extra_comp_country_priced |
| MP9 | sapient_royal_mail_international_business_parcels_signed_country_priced |
| MPL | sapient_royal_mail_international_business_mail_tracked_high_vol_country_priced |
| MPM | sapient_royal_mail_international_business_mail_tracked_signed_high_vol_country_priced |
| MPN | sapient_royal_mail_international_business_mail_signed_high_vol_country_priced |
| MPO | sapient_royal_mail_international_business_mail_tracked_high_vol_extra_comp_country_priced |
| MPP | sapient_royal_mail_international_business_mail_tracked_signed_high_vol_extra_comp_country_priced |
| MPR | sapient_royal_mail_international_business_parcel_tracked_boxable_country_priced |
| MTA | sapient_royal_mail_international_business_parcels_tracked_signed_zone_sort |
| MTB | sapient_royal_mail_international_business_parcels_tracked_signed_extra_compensation_zone_sort |
| MTC | sapient_royal_mail_international_business_mail_tracked_signed_zone_sort |
| MTE | sapient_royal_mail_international_business_parcels_tracked_signed_country_priced |
| MTF | sapient_royal_mail_international_business_parcels_tracked_signed_extra_compensation_country_priced |
| MTG | sapient_royal_mail_international_business_mail_tracked_signed_country_priced |
| MTI | sapient_royal_mail_international_business_mail_tracked_zone_sort |
| MTK | sapient_royal_mail_international_business_mail_tracked_country_priced |
| MTM | sapient_royal_mail_international_business_mail_signed_zone_sort |
| MTO | sapient_royal_mail_international_business_mail_signed_country_priced |
| MTP | sapient_royal_mail_international_business_mail_signed_extra_compensation_country_priced |
| MTS | sapient_royal_mail_international_business_parcels_tracked_direct_ireland_country |
| MTV | sapient_royal_mail_international_business_parcels_tracked_signed_ddp |
| OLA | sapient_royal_mail_international_standard_on_account |
| OLS | sapient_royal_mail_international_economy_on_account |
| OSA | sapient_royal_mail_international_signed_on_account |
| OSB | sapient_royal_mail_international_signed_on_account_extra_comp |
| OTA | sapient_royal_mail_international_tracked_on_account |
| OTB | sapient_royal_mail_international_tracked_on_account_extra_comp |
| OTC | sapient_royal_mail_international_tracked_signed_on_account |
| OTD | sapient_royal_mail_international_tracked_signed_on_account_extra_comp |
| PK0 | sapient_royal_mail_48_ll_flat_rate |
| PK1 | sapient_royal_mail_24_standard_signed_for_parcel_sort8_flat_rate_service |
| PK2 | sapient_royal_mail_48_standard_signed_for_parcel_sort8_flat_rate_service |
| PK3 | sapient_royal_mail_24_standard_signed_for_parcel_sort8_daily_rate_service |
| PK4 | sapient_royal_mail_48_standard_signed_for_parcel_sort8_daily_rate_service |
| PK7 | sapient_royal_mail_24_presorted_p |
| PK8 | sapient_royal_mail_48_presorted_p |
| PK9 | sapient_royal_mail_24_ll_flat_rate |
| PKB | sapient_royal_mail_rm24_presorted_p_annual_flat_rate |
| PKD | sapient_royal_mail_rm48_presorted_p_annual_flat_rate |
| PKK | sapient_royal_mail_rm48_presorted_ll_annual_flat_rate |
| PKM | sapient_royal_mail_rm24_presorted_ll_annual_flat_rate |
| PPF1 | sapient_royal_mail_24_standard_signed_for_packetpost_flat_rate_service |
| PPF2 | sapient_royal_mail_48_standard_signed_for_packetpost_flat_rate_service |
| PPJ1 | sapient_royal_mail_parcelpost_flat_rate_annual |
| PPJ2 | sapient_royal_mail_parcelpost_flat_rate_annual_PPJ |
| PPS | sapient_royal_mail_rm24_ll_annual_flat_rate |
| PPT | sapient_royal_mail_rm48_ll_annual_flat_rate |
| PS5 | sapient_royal_mail_international_business_personal_correspondence_max_sort_l |
| PS7 | sapient_royal_mail_international_business_mail_large_letter_max_sort_priority_service |
| PSA | sapient_royal_mail_international_business_mail_letters_max_sort_standard |
| PSB | sapient_royal_mail_international_business_mail_large_letter_max_sort_standard_service |
| RM0 | sapient_royal_mail_48_sort8p_annual_flat_rate |
| RM1 | sapient_royal_mail_24_ll_daily_rate |
| RM2 | sapient_royal_mail_24_p_daily_rate |
| RM3 | sapient_royal_mail_48_ll_daily_rate |
| RM4 | sapient_royal_mail_48_p_daily_rate |
| RM5 | sapient_royal_mail_24_p_flat_rate |
| RM6 | sapient_royal_mail_48_p_flat_rate |
| RM7 | sapient_royal_mail_24_sort8_ll_annual_flat_rate |
| RM8 | sapient_royal_mail_24_sort8_p_annual_flat_rate |
| RM9 | sapient_royal_mail_48_sort8_ll_annual_flat_rate |
| SD1 | sapient_royal_mail_special_delivery_guaranteed_by_1pm_750 |
| SD2 | sapient_royal_mail_special_delivery_guaranteed_by_1pm_1000 |
| SD3 | sapient_royal_mail_special_delivery_guaranteed_by_1pm_2500 |
| SD4 | sapient_royal_mail_special_delivery_guaranteed_by_9am_750 |
| SD5 | sapient_royal_mail_special_delivery_guaranteed_by_9am_1000 |
| SD6 | sapient_royal_mail_special_delivery_guaranteed_by_9am_2500 |
| SDA | sapient_royal_mail_special_delivery_guaranteed_by_1pm_id_750 |
| SDB | sapient_royal_mail_special_delivery_guaranteed_by_1pm_id_1000 |
| SDC | sapient_royal_mail_special_delivery_guaranteed_by_1pm_id_2500 |
| SDE | sapient_royal_mail_special_delivery_guaranteed_by_9am_id_750 |
| SDF | sapient_royal_mail_special_delivery_guaranteed_by_9am_id_1000 |
| SDG | sapient_royal_mail_special_delivery_guaranteed_by_9am_id_2500 |
| SDH | sapient_royal_mail_special_delivery_guaranteed_by_1pm_age_750 |
| SDJ | sapient_royal_mail_special_delivery_guaranteed_by_1pm_age_1000 |
| SDK | sapient_royal_mail_special_delivery_guaranteed_by_1pm_age_2500 |
| SDM | sapient_royal_mail_special_delivery_guaranteed_by_9am_age_750 |
| SDN | sapient_royal_mail_special_delivery_guaranteed_by_9am_age_1000 |
| SDQ | sapient_royal_mail_special_delivery_guaranteed_by_9am_age_2500 |
| SDV | sapient_royal_mail_special_delivery_guaranteed_age_750 |
| SDW | sapient_royal_mail_special_delivery_guaranteed_age_1000 |
| SDX | sapient_royal_mail_special_delivery_guaranteed_age_2500 |
| SDY | sapient_royal_mail_special_delivery_guaranteed_id_750 |
| SDZ | sapient_royal_mail_special_delivery_guaranteed_id_1000 |
| SEA | sapient_royal_mail_special_delivery_guaranteed_id_2500 |
| SEB | sapient_royal_mail_special_delivery_guaranteed_750 |
| SEC | sapient_royal_mail_special_delivery_guaranteed_1000 |
| SED | sapient_royal_mail_special_delivery_guaranteed_2500 |
| STL1 | sapient_royal_mail_1st_class_standard_signed_for_letters_daily_rate_service |
| STL2 | sapient_royal_mail_2nd_class_standard_signed_for_letters_daily_rate_service |
| TPA | sapient_royal_mail_tracked_24_high_volume_signature_age |
| TPB | sapient_royal_mail_tracked_48_high_volume_signature_age |
| TPC | sapient_royal_mail_tracked_24_signature_age |
| TPD | sapient_royal_mail_tracked_48_signature_age |
| TPL | sapient_royal_mail_tracked_48_high_volume_signature_no_signature |
| TPM | sapient_royal_mail_tracked_24_high_volume_signature_no_signature |
| TPN | sapient_royal_mail_tracked_24_signature_no_signature |
| TPS | sapient_royal_mail_tracked_48_signature_no_signature |
| TRL | sapient_royal_mail_tracked_letter_boxable_48_high_volume_signature_no_signature |
| TRM | sapient_royal_mail_tracked_letter_boxable_24_high_volume_signature_no_signature |
| TRN | sapient_royal_mail_tracked_letter_boxable_24_signature_no_signature |
| TRS | sapient_royal_mail_tracked_letter_boxable_48_signature_no_signature |
| TSN | sapient_royal_mail_tracked_returns_24 |
| TSS | sapient_royal_mail_tracked_returns_48 |
| WE1 | sapient_royal_mail_international_business_parcels_zero_sort_priority_WE |
| WG1 | sapient_royal_mail_international_business_mail_large_letter_zero_sort_priority |
| WG4 | sapient_royal_mail_international_business_mail_large_letter_zero_sort_priority_machine |
| WP1 | sapient_royal_mail_international_business_mail_letters_zero_sort_priority |
Shipping Options
| Option | Code | Type |
|---|---|---|
| sapient_CL1 | CL1 | float |
| sapient_CL2 | CL2 | float |
| sapient_CL3 | CL3 | float |
| sapient_CL4 | CL4 | float |
| sapient_CL5 | CL5 | float |
| sapient_signed | Signed | boolean |
| sapient_SMS | SMS | boolean |
| sapient_email | boolean | |
| sapient_localcollect | LocalCollect | boolean |
| sapient_customs_email | CustomsEmail | string |
| sapient_customs_phone | CustomsPhone | string |
| sapient_safeplace_location | Safeplace | string |
| sapient_ebay_vtn | EbayVtn | string |
| sapient_container_id | ContainerId | string |
| sapient_business_transaction_type | BusinessTransactionType | string |
