Record shipment

POST /openapi/Consignment/SaveConsignment — TMS API · Order and Shipment Record

Adds a new shipment (consignment) to previously recorded orders. The request is queued and returns a ticketNumber; query the result with GetTicketNumberStatus.

If you distribute with your own vehicle fleet, you can also send vehicle, driver, and route information with carInfo, driverInfo, and routeInfo.

İstek gövdesi

  • orders (object[], zorunlu): Orders to which the shipment will be added.
    • orders.orderNumber (string, zorunlu): Recorded order number.
    • orders.consignments (object[], zorunlu): Shipments to be added.
      • orders.consignments.attr1 (string): Free field 1.
      • orders.consignments.attr2 (string): Free field 2.
      • orders.consignments.attr3 (string): Free field 3.
      • orders.consignments.attr4 (string): Free field 4.
      • orders.consignments.attr5 (string): Free field 5.
      • orders.consignments.attr6 (string): Free field 6.
      • orders.consignments.attr7 (string): Free field 7.
      • orders.consignments.attr8 (string): Free field 8.
      • orders.consignments.attr9 (string): Free field 9.
      • orders.consignments.attr10 (string): Free field 10.
      • orders.consignments.weight (number): Weight (kg).
      • orders.consignments.products (object[]): Products in the shipment.
      • orders.consignments.vendorId (integer): Seller ID (marketplace seller shipment).
      • orders.consignments.totalPrice (number): Shipment amount.
      • orders.consignments.carrierCode (string): Carrier code. If empty, the carrier is selected according to account rules.
      • orders.consignments.currentPrice (number): Amount to be collected on cash on delivery.
      • orders.consignments.isChangeable (boolean): Can the carrier be changed later?
      • orders.consignments.locationCode (string): Departure location code. If empty, the account's default location is used.
      • orders.consignments.senderAddress (oneOf): Sender address (for marketplace customer-to-customer shipments).
      • orders.consignments.totalQuantity (integer): Number of products in the shipment.
      • orders.consignments.toLocationCode (string): Arrival location code (for store/warehouse transfer).
      • orders.consignments.isSendCargoData (boolean): Should shipment data be transmitted to the carrier?
      • orders.consignments.isVendorPackage (boolean): Is it a seller (vendor) shipment?
      • orders.consignments.paymentTypeCode (string): Payment type code (see GetPaymentTypes).
      • orders.consignments.pickUpPointCode (string): Delivery point (pick-up point) code.
      • orders.consignments.shippingAddress (object)
      • orders.consignments.deliverySlotCode (string): Delivery time slot code.
      • orders.consignments.deliveryTypeCode (string): Delivery type code.
      • orders.consignments.volumetricWeight (number): Volume (desi).
      • orders.consignments.consignmentNumber (string): Shipment (consignment/package) number.
      • orders.consignments.isStatusTrackManuel (boolean): Will status tracking be done manually (with Status Notification endpoints)?
      • orders.consignments.vendorAgreementTypeId (integer): Seller agreement type ID.
      • orders.consignments.pickUpPointCompanyCode (string): Delivery point company code.
      • orders.consignments.salesChannelTrackingNumber (string): Tracking number provided by the sales channel (marketplace).
      • orders.consignments.saleChannelConfigurationKey (string): Sales channel configuration key.
      • orders.consignments.estimatedPackagingCompletionDate (string<date-time>): Date of delivery to cargo.
      • orders.consignments.expectedPackagingCompletionDueDate (string<date-time>): Expected/agreed date of delivery to cargo by the marketplace.
  • carInfo (object): Vehicle information for own fleet distribution.
    • carInfo.carPlate (string): License plate.
    • carInfo.carTypeName (string): Vehicle type.
  • routeInfo (object): Route information for own fleet distribution.
    • routeInfo.count (integer): Number of stops on the route.
    • routeInfo.locations (string[]): Route location codes.
    • routeInfo.routeName (string): Route name.
  • clientCode (string, zorunlu): Organization code.
  • driverInfo (object): Driver information for own fleet distribution.
    • driverInfo.email (string): Email.
    • driverInfo.lastName (string): Last name.
    • driverInfo.password (string): Driver user's password.
    • driverInfo.firstName (string): First name.
    • driverInfo.driverUserName (string): Driver username.
  • accountCode (string, zorunlu): Account code.
  • salesChannelCode (string): Sales channel/marketplace code.

Yanıtlar

  • 200: Record queued (or sync processed).
  • 400: Account could not be verified or sync record returned an error.
  • 401: No token, invalid or expired (empty body response).
  • 429: Request limit exceeded.

200 yanıt alanları