1. Shipping Label
  • Authentication API
    • Generate API Token
      POST
  • Create Orders
    • Create Order
      POST
  • Cancel Orders
    • Cancel Order
      PUT
  • Shipping Label
    • Download Shipping Label
      POST
    • Shipping Label Configurations
      GET
    • Update Shipping Label Configurations
      PUT
  • Shipment Tracking
    • Tracking
      GET
  • Couriers
    • Courier Partners
      GET
  • NDR
    • Reattempt NDR
      PUT
  • Pickup Addresses
    • Pickup Hub ids
      GET
    • Create Pickup Hub Id
      POST
    • Pickup Hub Id
      DELETE
  • Shipping Rates
    • Get Shipping Rate (Retail)
      GET
  1. Shipping Label

Shipping Label Configurations

GET
https://api.sharkship.in/v1/b2c/document/shipping_label_configuration
Retrieves the current shipping label display configurations for your account.
Endpoint: GET /v1/b2c/document/shipping_label_configuration
Headers:
Authorization: Bearer <token>
Response (200): Returns the shipping label configuration object.
FieldTypeDescription
idintegerConfiguration record ID
rto_visibilitybooleanWhether RTO address is shown on the label
sharkship_visibilitybooleanWhether Sharkship branding is shown
logo_visibilitybooleanWhether seller logo is shown
gst_visibilitybooleanWhether GST details are shown
client_visibilitybooleanWhether client order ID is shown
sku_visibilitybooleanWhether SKU is shown
alter_namebooleanWhether an alternate seller name is used
phone_visibilitybooleanWhether customer phone number is shown
rto_phone_visibilitybooleanWhether seller phone number is shown
table_visibilitybooleanWhether line items table is shown
isAmountVisiblebooleanWhether order amount is shown
newNamestringAlternate seller name
labelSizestringLabel format: STANDARD, THERMAL, or 4x4

Request

Header Params

Responses

🟢200
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.sharkship.in/v1/b2c/document/shipping_label_configuration' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "id": 1,
    "rto_visibility": true,
    "sharkship_visibility": true,
    "logo_visibility": true,
    "gst_visibility": true,
    "client_visibility": true,
    "sku_visibility": true,
    "alter_name": true,
    "phone_visibility": true,
    "rto_phone_visibility": true,
    "table_visibility": true,
    "isAmountVisible": true,
    "newName": "string",
    "labelSize": "STANDARD"
}
Modified at 2026-06-16 10:11:15
Previous
Download Shipping Label
Next
Update Shipping Label Configurations
Built with