Passa al contenuto principale

Add shipping parcels to order​

Add shipping parcels to order, using id of a pre loaded parcel or using raw data of a parcel

Path Parameters
  • storeOrderId string required
Request Body array
  • Array [
  • anyOf
  • parcelId number required
  • ]
    • Responses

    Default Response

    Schema
    • uuid regex required

      Possible values: Value must match regular expression /^o-[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$/i

    • updated date-time required
    • created date-time required
    • status

      Possible values: [pending, partially_fulfilled, fulfilled, error, refunded, exception, cancelled, generating_labels, externally_handled, in_transit, delivered]

    • storeOrderId string
    • storeInternalOrderId string
    • storeCreationDate date-time required
    • total number required
    • subtotal number
    • shippingTotal number
    • currency string required

      Possible values: >= 3 characters and <= 3 characters

    • shippingMethod string
    • paymentMethod string
    • itemsCount number
    • firstItemImageUrl string
    • trackingInformation object[]
    • Array [
    • number string required
    • url string
    • status

      Possible values: [P, T, D, E, F, R, U]

    • ]
    • customerNote string
    • error object
    • message
    • code string
    • i18nCode string
    • date date-time
    • shippingInformation object
    • parcels object[]
    • Array [
    • uuid string
    • name string
    • parcelId string
    • monetaryValue number
    • currency string

      Possible values: >= 3 characters and <= 3 characters

    • referenceNumber string
    • description string
    • width number required
    • height number required
    • length number required
    • weight number required
    • packagingWeight number
    • weightUnit required

      Possible values: [g, kg, oz, lb]

    • lengthUnit required

      Possible values: [cm, in]

    • isWeightDynamic boolean
    • ]
    • shipmentDetails object
    • carrierNotes string
    • goodsMonetaryValue number
    • goodsCurrency string

      Possible values: >= 3 characters and <= 3 characters

    • shipmentReferences string[]
    • additionalServices object
    • insurance object
    • monetaryValue number required
    • currency string required

      Possible values: >= 3 characters and <= 3 characters

    • cod object
    • monetaryValue number required
    • currency string required

      Possible values: >= 3 characters and <= 3 characters

    • saturdayDelivery boolean
    • signature boolean
    • adultSignature boolean
    • selectedCarrierId number
    • serviceCode string
    • addressTo object
    • name string required
    • companyName string
    • street string required
    • street2 string
    • city string required
    • state string required
    • countryIsoCode string required

      Possible values: <= 2 characters

    • zipCode string required
    • phoneNumber string
    • email email
    • addressFrom object
    • name string required
    • companyName string
    • street string required
    • street2 string
    • city string required
    • state string required
    • countryIsoCode string required

      Possible values: <= 2 characters

    • zipCode string required
    • phoneNumber string
    • email email
    • addressDelivery object
    • name string required
    • companyName string
    • street string
    • street2 string
    • city string required
    • state string required
    • countryIsoCode string required

      Possible values: <= 2 characters

    • zipCode string required
    • phoneNumber string
    • email email
    • pudoId string
    • deliveryDayEstimate date-time
    • items object[] required
    • Array [
    • uuid regex required

      Possible values: Value must match regular expression ^i-[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$

    • quantity number required
    • name string required
    • weight number
    • imageUrl string
    • weightUnit string
    • price number
    • productId string
    • sku string
    • asin string

      Possible values: non-empty

    • ]
    Loading...