POST api/v{version}/warehouse/shipment/{ShipmentBarCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ShipmentBarCode

string

Required

version

string

None.

Body Parameters

WarehouseRequest
NameDescriptionTypeAdditional information
warehouse_id

string

Required

auth_token

string

Required

ts

string

Required

Request Formats

application/json, text/json

Sample:
{
  "warehouse_id": "sample string 1",
  "auth_token": "sample string 2",
  "ts": "sample string 3"
}

Response Information

Resource Description

ModelAPIWarehouseShipmentInformation
NameDescriptionTypeAdditional information
PointID

integer

None.

PointInformation

ModelAPIWarehousePointInformation

None.

Reference

string

None.

Option

WarehouseDeliveryOption

None.

OptionString

string

None.

DeliverTo

ApiAddressWithNameOrCompany

None.

DeliverVia

ApiAddressWithNameOrCompany

None.

ShipmentID

string

None.

PickupID

string

None.

Parcels

integer

None.

ParcelIDs

Collection of string

None.

IsError

boolean

None.

ErrorMessage

string

None.

ErrorID

string

None.

Response Formats

application/json, text/json

Sample:
{
  "PointID": 2,
  "PointInformation": {
    "ContactName": null,
    "ContactNumber": null,
    "OpeningHours": {
      "Days": []
    }
  },
  "Reference": "sample string 3",
  "Option": 1,
  "OptionString": "ToPoint",
  "DeliverTo": {
    "n": "sample string 1",
    "s": "sample string 2",
    "e": "sample string 3",
    "c": "sample string 4",
    "l": "sample string 5",
    "p": "sample string 6",
    "d": "sample string 7",
    "y": "sample string 8"
  },
  "DeliverVia": {
    "n": "sample string 1",
    "s": "sample string 2",
    "e": "sample string 3",
    "c": "sample string 4",
    "l": "sample string 5",
    "p": "sample string 6",
    "d": "sample string 7",
    "y": "sample string 8"
  },
  "ShipmentID": "sample string 4",
  "PickupID": "sample string 5",
  "Parcels": 6,
  "ParcelIDs": [
    "sample string 4001",
    "sample string 4002",
    "sample string 4003",
    "sample string 4004",
    "sample string 4005",
    "sample string 4006"
  ],
  "IsError": true,
  "ErrorMessage": "sample string 9",
  "ErrorID": "sample string 10"
}