API Documentation

Update Document Details Linked with Shipment

put
https://coreapi.impexdocs.com/api/v1/documents/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string | null

Unique identification and mandatory field 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

string | null

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

string
required
string | null

This is Status of the Document.

int32
required

This defines the sequence number of the document attached with shipment. Sequence of 'Master' document will be either '0' or '1'.

string
required
string | null

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

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.

string | null

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

header_details
object

object for HeaderDetails

payment_details
object
processing_dates
object
additional_info
object
other_info
object
partner
array of objects | null
partner
exporter_bank
object
buyer_bank
object
product_detail
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

Updated 14 days ago

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

Updated 14 days ago