Create Shipment

post

https://coreapi.impexdocs.com/api/v1/shipment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

shipment Object

shipment_no

string

required

length between 1 and 50

Unique identification to create and update a shipment record. If system generated numbering do not send a value, if the numbering is from an external system, a unique value is required

shipment_status

string

required

length between 1 and 50

This is the Current Status of the Shipment. While creating shipment, default value "Created" needs to be passed.

order_category

string | null

This is the default and required field for a Shipment It can influence numbering and screen.Default value to be sent : SH

booking_id

uuid | null

This the Booking Id. If value is passed, Shipment will be linked with Booking. To link Booking with Shipment, Booking needs to be created before Shipment.

shipment_owner

string | null

Requires to be an email address of the user who has a login in Impexdocs.

document_list_default

string | null

enum

Optional tag. If Value is passed as “true” , Shipment will be created with Document List marked as Default -true in Application.

Allowed:

document_list_code

string | null

Optional tag. If require to choose a desire document List (other than default documents list) while creating a Shipment, need to pass a validate Document List code as value also mark field “document_list_default” as “true”

document_default

string | null

enum

Optional tag. It will fetch User’s profile Document default if value is “true”

Allowed:

header_details

object

object for HeaderDetails

payment_details

object

processing_dates

object

additional_info

object

other_info

object

partner_code_validation

boolean

Validation on Partner Code is optional. If value is false, we will save the Partner data without any validation. If value is true, we will validate Partner Code. Blank and Invalid code will not be allowed.

partner_default

string | null

enum

Optional tag. To fetch Address details against a provide Partner Code (Customer/Partner Profile), mark tag as “true” and only provide partner_type and code. This tag is supported at time of Shipment creation only.

Allowed:

partner

array of objects | null

partner

exporter_bank

object

buyer_bank

object

product_detail

object

internal_notes_details

object

packing_details

object

external_documents

array of objects | null

external_documents

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

500

Server Error

503

Server Error

201Created

400Bad Request

409Conflict

422Client Error