Add Product Line to Shipment

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

Overview

HTTP Method: PUT

Endpoint URL: https://coreapi.impexdocs.com/api/v1/shipment/product/{shipmentdocs_id}

Authentication: Required

Response Format: JSON

Description

To add a product line in a Shipment, make a PUT request to the specified endpoint with the required information. The response will be a JSON object containing:

  • Response Code
  • Message
  • Result

Request

Path Parameter

  • Shipment Docs ID (shipmentdocs_id): The identifier generated during the creation of a new Shipment. Retrieve this ID from the response of the POST Shipment API.

Example Path Parameter

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

Example Request

Ensure to include the Shipmentdocs ID in the path and provide any additional fields that need modification in the request JSON.

Response

The API will respond with a JSON object containing:

  • Response Code
  • Message
  • Result

Example Response JSON

{
  "response_code": 200,
  "message": "Updated",
  "result": "Record Updated Successfully"
}

Note

  • Ensure proper authentication before making the request.
  • Use the Shipmentdocs ID obtained during the creation of the Shipment for the path parameter.
  • Provide the necessary fields to be modified in the request JSON.
Path Params
uuid
required
Body Params
string | null
enum
Allowed:
product
array of objects | null
product
pricing_details
object
boolean | null
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