Create And Link COO with Shipment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

HTTP Method: POST

Endpoint URL: https://coreapi.impexdocs.com/api/v1/coo

Authentication: Required

Response Format: JSON

Description

This API allows you to programmatically manage COO document within our platform. To use the COO creation endpoint, authentication is required. Ensure that your application is authenticated using the provided API key or access token.

Request

To create a COO, provide the following mandatory inputs in the request JSON:

  1. Shipment Folder Detail Id (shipmentfolderdetail_id): The shipment number is the primary key used to uniquely identify each Shipment in our system. It is essential for updating and retrieving data.

  2. Exporter Reference (exporter_reference):

  3. Customer Reference (customer_reference):

  4. Chamber of Commerce (chamber_of_commerce):

  5. Document Type (document_type):

  6. Transaction Type (transaction_type):

Response

The API will respond with a JSON object containing the following:

  • Response Code
  • Message
  • Shipment Docs ID
  • Shipment Folder Detail ID
  • Request JSON

Example Response JSON

{
    "response_code": 2000,
    "message": "Created",
    "result": [
        {
            "shipment_docs_id": "4d256420-580d-424d-8ece-646478961094",
            "shipment_folder_detail_id": "72654565-5cc5-4a78-8875-d71cg4yu208c",
            "request_json": "{\"header_details\":{\"shipmentfolderdetail_id\":\"72659805-5cc5-4a78-8875-d71cb8af208c\",\"shipment_no\":\"string\",\"document_list\":[{\"code\":\"RFP\"}],\"document_name\":\"rfp16_Egg6\",\"sequence\":22,\"commodity\":2,\"exporter_number\":\"105021\",\"exporter_number_desc\":\"Ultimate Global Trading Pty Ltd\",\"message_type\":9,\"exporter_reference\":\"EXP-12651-01\",\"customer_ref\":\"CUST-2392\",\"edn\":\"EDN-3905\",\"certificate_print_ind\":3,\"certificate_required_location\":\"string\",\"certificate_req_loc_desc\":\"string\"},\"shipping_details\":{\"departure_date\":\"10/30/1909\",\"transport_mode\":1,\"rfp_authorization_establishment_no\":\"string\",\"rfp_authorization_establishment_no_desc\":\"string\",\"loading_port\":\"abc\",\"loading_port_desc\":\"abcde\",\"vessel_name\":\"string\",\"establishment_region\":\"str\",\"daff_region_desc\":\"string\",\"product_source_country\":\"st\",\"product_source_country_desc\":\"string\",\"voyage_no\":\"string\",\"border_inspection_port\":\"strin\",\"border_inspection_port_desc\":\"string\",\"discharge_port\":\"strin\",\"discharge_port_desc\":\"string\",\"shipping_company\":\"string\",\"transit_country_1\":\"st\",\"transit_country_1_Desc\":\"string\",\"transit_country_2\":\"st\",\"transit_country_2_desc\":\"string\",\"transit_country_3\":\"st\",\"transit_country_3_desc\":\"string\",\"transit_country_4\":\"st\",\"transit_country_4_desc\":\"string\",\"container_certificate\":0,\"marks_certificate\":0,\"packers_certificate\":0,\"ship_stores_ind\":0,\"destination_country\":\"st\",\"destination_country_desc\":\"string\",\"exporter_declaration\":\"string\",\"destination_city\":\"string\",\"storage_establishment_no\":\"string\",\"storage_establishment_no_desc\":\"string\",\"consignee_name\":\"string\",\"city\":\"string\",\"postcode\":\"string\",\"street_1\":\"string\",\"state\":\"string\",\"country\":\"st\",\"country_desc\":\"string\",\"street_2\":\"string\",\"representative\":\"string\",\"reference_no\":\"string\",\"declaring_agent_no\":\"string\",\"phone_no\":\"string\",\"traces_approval_id\":\"string\",\"import_permit_number_1\":\"string\",\"import_permit_date_1\":\"08/30/1930\",\"import_permit_number_2\":\"string\",\"import_permit_date_2\":\"01/23/2992\",\"import_permit_number_3\":\"string\",\"import_permit_date_3\":\"02/29/1608\",\"import_permit_number_4\":\"string\",\"import_permit_date_4\":\"12/30/9272\",\"import_permit_number_5\":\"string\",\"import_permit_date_5\":\"12/31/3064\",\"import_permit_number_6\":\"string\",\"import_permit_date_6\":\"02/13/4831\"},\"edn_details\":{\"is_edn_required\":0,\"exporter_type\":7,\"fob_currency_unit\":\"str\",\"fob_currency_unit_desc\":\"string\"},\"other_details\":{\"transhipment_temperature\":\"string\",\"transhipment_temperature_unit\":1,\"prod_use_ind\":1,\"avg_animal_age\":0,\"min_temperature\":\"string\",\"max_temperature\":\"string\",\"decl_of_compliance_ind\":\"string\",\"true_comp_ind\":\"string\",\"origin_catching_zone_1\":\"string\",\"origin_catching_zone_2\":\"string\",\"origin_catching_zone_3\":\"string\",\"lot_number\":\"string\",\"amended_info\":\"string\",\"compartment_1\":\"string\",\"compartment_2\":\"string\",\"compartment_3\":\"string\",\"compartment_4\":\"string\",\"insp_port_1\":\"string\",\"insp_port_2\":\"string\",\"insp_port_3\":\"string\",\"insp_port_4\":\"string\",\"ship_hold_insp_date_1\":\"02/04/8984\",\"ship_hold_insp_date_2\":\"02/29/4000\",\"ship_hold_insp_date_3\":\"02/24/2164\",\"ship_hold_insp_date_4\":\"02/28/1913\",\"discharge_port_2\":\"string\",\"discharge_port_3\":\"string\",\"discharge_port_2_desc\":\"string\",\"discharge_port_3_desc\":\"string\",\"notify_party_text_1\":\"string\",\"notify_party_text_2\":\"string\",\"notify_party_text_3\":\"string\",\"notify_party_text_4\":\"string\",\"notify_party_text_5\":\"string\",\"notify_party_text_6\":\"string\",\"notify_party_text_7\":\"string\",\"notify_party_text_8\":\"string\",\"additional_Info\":\"string\",\"approved_certifier\":\"strin\",\"approved_certifier_desc\":\"string\",\"aml_cquota_ind\":0,\"aml_cquata_year\":\"string\",\"recommendation_letter_number\":\"string\",\"recommendation_letter_date\":\"10/16/6536\",\"recommendation_letter_number_1\":\"string\",\"recommendation_letter_date_1\":\"12/21/4584\",\"recommendation_letter_number_2\":\"string\",\"recommendation_letter_date_2\":\"12/12/3778\",\"recommendation_letter_number_3\":\"string\",\"recommendation_letter_date_3\":\"08/09/1924\",\"recommendation_letter_number_4\":\"string\",\"recommendation_letter_date_4\":\"12/05/7878\",\"recommendation_letter_number_5\":\"string\",\"recommendation_letter_date_5\":\"07/13/5557\",\"letter_of_credit\":\"string\",\"loading_port_2\":\"str\",\"loading_port_2_desc\":\"string\",\"loading_port_3\":\"str\",\"loading_port_3_desc\":\"string\",\"loading_port_4\":\"str\",\"loading_port_4_Desc\":\"string\",\"loading_port_5\":\"str\",\"loading_port_5_desc\":\"string\",\"pack_date\":\"08/22/1936\",\"line_cust_wt_qty\":\"string\",\"line_cust_wt_unit_desc\":\"string\",\"line_cust_wt_unit\":\"string\",\"salting_date\":\"string\",\"label_approval_num\":\"string\",\"chem_lean_per\":\"st\",\"amlc_perf_exp_num\":\"strin\",\"amlc_perf_exp_num_desc\":\"string\",\"label_approval_ind\":0,\"beef_veel_per_amt\":\"string\",\"amlc_qut_app_refer\":\"string\",\"ungraded_product_ind\":0,\"dominant_product\":\"string\",\"dominant_product_desc\":\"string\",\"quality_qualifier\":\"string\",\"additional_product\":\"string\",\"additional_product_desc\":\"string\",\"location_qualifier\":\"string\"},\"forward_transfer_details\":{\"forwardee_edi_User_identifier\":\"string\",\"transferee_exporter_no\":\"string\",\"transferee_exporter_no_desc\":\"string\",\"cancel_transfer_ind\":0,\"forward_status\":\"COMP\",\"transferee_edi_user_identifier\":\"string\"},\"inspection_details\":{\"vessel_hold_start_seal_number\":\"string\",\"vessel_hold_end_seal_number\":\"string\",\"rfp_Off_identifier\":\"string\",\"inspector_comments\":\"string\",\"rfp_inspection_start_date\":\"12/16/5021\",\"rfp_inspection_end_date\":\"02/29/1600\",\"rfp_inspection_req_date\":\"10/31/1955\",\"rfp_inspection_req_time\":\"string\"},\"additional_person_resp_details\":{\"name\":\"string\",\"city\":\"string\",\"postcode\":\"string\",\"street_1\":\"string\",\"country\":\"st\",\"country_desc\":\"string\",\"phone_no\":\"string\",\"street_2\":\"string\"},\"destination_place_details\":{\"name\":\"string\",\"city\":\"string\",\"phone_no\":\"string\",\"street_1\":\"string\",\"postcode\":\"string\",\"approval_no\":\"string\",\"street_2\":\"string\",\"country\":\"st\",\"country_desc\":\"string\",\"type\":0},\"product_lines_details\":{\"product_line\":[{\"line_number\":99,\"preservation_type\":\"s\",\"preservation_type_desc\":\"string\",\"product_type\":\"str\",\"product_type_desc\":\"string\",\"pack_type\":\"st\",\"pack_type_desc\":\"string\",\"supplementary_code\":\"st\",\"supplementary_code_desc\":\"string\",\"cut_code\":\"string\",\"cut_code_desc\":\"string\",\"ahecc_code\":\"string\",\"ahecc_code_desc\":\"string\",\"fob_value\":\"string\",\"product_source_state\":\"string\",\"durability_start_date\":\"08/05/1902\",\"durability_end_date\":\"10/09/4038\",\"shipping_marks\":\"string\",\"batch_code\":\"string\",\"final_consumer\":1,\"certificate_template\":\"string\",\"endorsement_code\":\"stri\",\"exdocs_gen_Product_desc\":\"string\",\"rfp_line_item_description\":\"string\",\"health_cert_desc\":\"string\",\"additional_prod_desc\":\"string\",\"client_line_item_identifier\":\"string\",\"import_authority_code\":\"string\",\"product_country_of_origin\":\"st\",\"product_country_of_Origin_desc\":\"string\",\"fish_water_indicator\":1,\"export_permit_number\":\"string\",\"export_permit_date\":\"02/29/1824\",\"export_scheme_code\":\"str\",\"export_scheme_code_desc\":\"string\",\"export_permit_type\":\"string\",\"export_permit_type_desc\":\"string\",\"extra_certificate_treatment_details\":[{\"grid_treatment_line\":\"string\",\"grid_extra_certtificate\":\"string\",\"add_dec_text\":\"string\",\"free_txt_stmnt\":\"string\",\"halal_product_ind\":0}],\"process_details\":[{\"estab_no_desc\":\"\",\"start_date\":\"01/30/9132\",\"end_date\":\"02/17/1948\",\"estab_no\":\"string\",\"process_type_code\":1,\"estb_name\":\"string\",\"estab_street\":\"string\",\"estab_street_2\":\"string\",\"estab_city\":\"string\",\"estab_state\":\"string\",\"estab_country\":\"string\",\"estab_post_code\":\"string\",\"estab_phone_no\":\"string\",\"estab_contact_name\":\"string\",\"catch_start_date\":\"02/28/4348\",\"catch_end_date\":\"02/29/8800\",\"commodity_nature\":\"st\",\"commodity_nature_desc\":\"string\",\"treatment_type\":\"str\",\"treatment_type_desc\":\"string\",\"drained_wt\":\"string\",\"drained_wt_unit\":\"str\",\"drained_wt_unit_desc\":\"string\",\"coded_st_1\":\"stri\",\"coded_st_2\":\"stri\",\"coded_st_3\":\"stri\",\"coded_st_4\":\"stri\",\"coded_st_5\":\"stri\",\"line_cust_wt_qty\":\"string\",\"line_cust_wt_unit\":\"str\",\"line_cust_wt_unit_desc\":\"string\",\"add_dec_text\":\"string\",\"commercial_prod_desc\":\"string\",\"grower_number\":\"string\"}],\"treatment_details\":null,\"harvest_details\":[{\"container_id\":\"string\",\"har_start\":\"02/19/1993\",\"har_end\":\"02/29/8000\",\"depur_date\":\"07/30/8339\",\"harvest_area\":\"string\",\"lease_num\":\"string\",\"depur_plant\":\"string\"}]}],\"packaging_container_details\":{\"outer_package_qty\":\"string\",\"outer_package_type\":\"st\",\"outer_package_type_desc\":\"string\",\"outer_aaccuracy_indicator\":\"Approximate\",\"individual_package_wt_amt\":\"string\",\"outer_package_weight_unit\":\"str\",\"outer_package_weight_unit_desc\":\"string\",\"interm_package_qty\":\"string\",\"interm_package_type\":\"st\",\"interm_package_type_desc\":\"string\",\"interm_accuracy_indicator\":\"Approximate\",\"interm_individual_package_wt_amt\":\"string\",\"interm_package_weight_unit\":\"str\",\"interm_package_weight_unit_desc\":\"string\",\"inner_package_qty\":\"string\",\"inner_package_type\":\"st\",\"inner_package_type_desc\":\"string\",\"inner_accuracy_indicator\":\"Approximate\",\"inner_individual_package_wt_amt\":\"string\",\"inner_package_weight_unit\":\"str\",\"inner_package_weight_unit_desc\":\"string\",\"net_qty\":\"string\",\"net_quantity_unit\":\"str\",\"net_quantity_unit_desc\":\"string\",\"gross_wt\":\"string\",\"gross_weight_unit\":\"str\",\"gross_weight_unit_desc\":\"string\",\"imperial_net_weight\":\"string\",\"imperial_unit\":\"str\",\"imperial_unit_desc\":\"string\",\"seal_start_number\":\"string\",\"seal_end_number\":\"string\",\"grid_product_container_line\":\"string\",\"grid_process_line\":\"string\"}},\"manufacturer_details\":[{\"man_line_number\":0,\"man_name\":\"string\",\"man_street_line_first\":\"string\",\"man_street_line_second\":\"string\",\"man_city\":\"string\",\"man_state\":\"string\",\"man_country\":\"string\",\"man_country_desc\":\"string\",\"man_postcode\":\"string\",\"row_id\":\"string\",\"shipment_docs_id\":\"string\"}],\"attachment_details\":[{\"attachment_name\":\"string\",\"attachment_type\":\"string\",\"attachment_desc\":\"string\",\"description\":\"string\",\"mime_type\":\"string\"}]}"
        }
    ]
}

Note

  • Ensure proper authentication before making the request.
  • Use the Shipment Folder Detail Id obtained from the response for further operations.
Body Params
uuid | null
int32 | null
general_detail
object
transport_and_loading_details
object
signtory_details
object
additional_details
object
CooPartnerType
array of objects | null
CooPartnerType
file_upload
array of objects | null
file_upload
line_items
array of objects | null
line_items
Headers
string | null

Company ID (Optional)

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

500

Server Error

503

Server Error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json