1. Schemas
FlavorCloud Partner API Documentation
  • Getting Started Guide for Merchants
  • B2B International Shipping Guide
  • Getting Started Guide for 3PLs
  • Returns Guide
  • Authentication
    • Get Auth Token
  • Rates
    • Get Rates
    • Get Multi Rates
  • Shipments
    • Create Shipments
    • Get Shipments
    • Cancel Shipments
  • Tracking
    • Get Tracking Detail
  • Classifications
    • Get Classification
  • Landed Cost
    • Get Landed Cost
  • Webhooks
    • Subscribe Webhooks
    • Unsubscribe Webhooks
  • Invoices
    • Get Invoice Detail
    • Get Invoices
  • Schemas
    • Schemas
      • ClassificationStatus
      • ProductResponse
      • ClassificationResponse
      • MissingProperty
      • ResponseDetails
      • ResponseData
      • ErrorResponse
      • ClassificationProduct
      • ClassificationRequest
      • InvoiceResponse
      • CustomerResponse
      • AccountInformation
      • ShippingOrigin
      • AveragePackageSettings
      • CreateCustomerRequest
      • CreateCustomerResponse
      • GetCustomerResponse
      • LandedCostResponse
      • Piece
      • Address
      • LandedCostRequest
      • CreateManifestShipmentResponse
      • CreateManifestShipmentRequest
      • GetManifestShipmentResponse
      • RateDetailDDU
      • LandedCostDetail
      • RateDetailDDP
      • TradeModel
      • RatesResponse
      • QuoteToAddress
      • QuoteFromAddress
      • QuotePiece
      • Package
      • QuoteRequest
      • RateRequest
      • ShipmentPackage
      • ShipmentsModel
      • MultiRateRequest
      • ShipmentsModelQuote
      • MultiQuoteRequest
      • RateDetailReponse
      • ShipmentBatches
      • ShipFromAddress
      • ShipToAddress
      • IndiaExportInfo
      • Metadata
      • BatchRequest
      • BatchUpdateReqModel
      • BatchCloseReqModel
      • ShipmentBatchesResponseModel
      • ShipmentResponse
      • ShipmentResponseExcluding_ConsolidateLabel_
      • ShipmentRequest
      • CancelShipmentResponse
      • CancelShipmentRequest
      • TrackingHistory
      • TrackingAPIResponse
      • CreateWebhookResponse
      • WebHookInfo
      • SubscribeWebhooksRequest
      • UnSubscribeWebhookRequest
  1. Schemas

BatchRequest(BatchRequest)

{
    "AppID": "string",
    "RestApiKey": "string",
    "CustomerKey": "string",
    "HashKey": "string",
    "DutyHashKey": "string",
    "PickUpDate": "string",
    "Async": false,
    "Reference": "string",
    "BatchID": "string",
    "LabelFormat": "PDF",
    "WeightUnit": "KG",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "N",
    "ServiceCode": "STANDARD",
    "TermsOfTrade": "DDP",
    "IsReturn": "N",
    "ShipmentKey": "string",
    "ShipFromAddress": {
        "Name": "Test Shipper",
        "AttentionName": "Test Shipper",
        "LocationName": "",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "AddressLine3": "string",
        "City": "string",
        "State": "string",
        "Country": "string",
        "Zip": "string",
        "Phone": "string",
        "Email": "string"
    },
    "ShipToAddress": {
        "Name": "Test consignee",
        "AttentionName": "Test consignee",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "AddressLine3": "string",
        "City": "string",
        "State": "string",
        "Country": "string",
        "Zip": "string",
        "Phone": "string",
        "Email": "string",
        "FederalTaxId": "string",
        "StateTaxId": "string"
    },
    "ReasonForExport": "merchandise",
    "Metadata": {
        "IndiaExportInfo": {
            "DocumentId": "string",
            "DocumentType": "string",
            "IEC": "string",
            "PAN": "string",
            "GST": "string",
            "BankAdCode": "string",
            "BankIfscCode": "string",
            "BankAccountNumber": "string"
        }
    },
    "B2b": false,
    "IsNewShipment": false
}
Built with