Skip to main content

Get Booking

GET 
/api/v1/bookings/:booking_id

Get Booking

Request​

Path Parameters

    booking_id stringrequired

Responses​

OK

Schema

    data

    object

    actualInspectionDate date-time

    Actual inspection date

    bookingId string

    Unique identifier of the booking

    bookingType string

    Booking type e.g normal

    caseNumber string

    Case number of the booking defined by a configuration rule

    clientInformation

    object

    Information on the Brand or Retailer in the booking

    address string
    city string

    contact

    object

    nullable

    contactId string
    email string
    mobileNumber string
    name string
    telephoneNumber string
    country string
    localOrganizationId string

    Local Custom ID of the organization

    localOrganizationIds string[]nullable

    The list of all connected Local Custom IDs of the organization

    name string
    organizationId string
    confirmedBy string

    The organization which confirmed the booking

    confirmedDate date-time

    Date when the booking was confirmed

    createdBy string

    The user who created the booking

    createdDate date-time

    Creation date of the booking

    detailOfPIPO

    object

    Details of PIPO

    pipoInformation

    object

    opoNumber string
    poNumber string
    poTypes string[]
    productLineId string
    productLineName string

    styles

    object[]

  • Array [

    • assortments

    object[]

    nullable

  • Array [

    • assortmentId stringrequired

    Possible values: non-empty

    availableCartonQuantity integernullable
    cartonQuantity integerrequired

    items

    object[]

    required

    Possible values: >= 1

  • Array [

    • availableQuantity integernullable
    brandId stringnullable

    Precondition: must be configured in your Inspectorio's account.

    brandName string

    Possible values: non-empty

    classId stringnullable
    color stringrequired

    Possible values: non-empty

    configuration integerrequired

    Possible values: >= 1

    departmentId stringnullable
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    quantity integer
    shipmentTerm stringnullable
    size stringrequired

    Possible values: non-empty

  • ]

  • ]

    • measurements

    object[]

  • Array [

    • caption stringrequired

    Possible values: non-empty

    isPomCritical booleannullable

    Measurement is critical or not

    pom stringrequired

    Possible values: non-empty

    sizes

    object[]

  • Array [

    • measurement stringrequired
    size stringrequired

    Possible values: non-empty

    Size name

  • ]

    • tolerance stringrequired
    toleranceLower numbernullable

    Accepted lower limit between the expected measure (standard) and the actual measure

    toleranceUpper numbernullable

    Accepted upper limit between the expected measure (standard) and the actual measure

    unit stringrequired

    Possible values: [inch, cm, mm]

  • ]

    • productCategoryId stringrequired
    productCategoryName string

    Possible values: non-empty

    solids

    object[]

    nullable

  • Array [

    • availableCartonQuantity integernullable
    availableQuantity integernullable
    brandId stringnullable

    Precondition: must be configured in your Inspectorio's account.

    brandName string

    Possible values: non-empty

    cartonQuantity integernullable
    casePackQuantity integernullable
    classId stringnullable
    color stringrequired

    Possible values: non-empty

    departmentId stringnullable
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    quantity integerrequired

    Possible values: >= 1

    shipmentTerm stringnullable
    size stringrequired

    Possible values: non-empty

  • ]

    • styleId stringrequired

    Possible values: non-empty

    styleName stringnullable

  • ]

    • expectedDate

    object

    Expected date

    inspectionDate date-timerequired
    shipmentDate date-timenullable

    factoryInformation

    object

    Information on the factory in the booking

    address string
    city string

    contact

    object

    nullable

    contactId string
    email string
    mobileNumber string
    name string
    telephoneNumber string
    country string
    localOrganizationId string

    Local Custom ID of the organization

    localOrganizationIds string[]nullable

    The list of all connected Local Custom IDs of the organization

    name string
    organizationId string
    fromOrganizationId string

    Organization ID where the booking is created

    fromOrganizationName string

    inspectionInformation

    object

    Inspection Information

    typeOfInspection string
    typeOfInspectionName string

    locationPicker

    object

    Location picker of where the inspection takes place

    address string

    gpsLocation

    object

    latitude string
    longitude string

    questionnaire

    object

    questions

    object[]

    List of questions in the questionnaire

  • Array [

    • defaultSubQuestions object[]

    List of recursive questions from "questionnaire"

    description string

    Description of the question

    freeTextAnswer string

    Free text answer for the question

    id stringrequired

    Unique identifier of a question

    options

    object[]

    List of answering options

  • Array [

    • id string

    Unique identifier of the option

    otherOptionText string

    Other option text

    questions object[]

    List of recursive questions from "questionnaire"

    selected boolean

    Indicate whether this option is selected or not

    text string

    Preset answer in text

  • ]

    • questionType stringrequired

    Question type e.g single select, multiple select

    responseId string

    Unique identifier of a response

    validation

    object

    required

    Question validation

    mandatory booleanrequired

    Indicate if the question is mandatory or not

  • ]

    • remark string

    Remark on the booking

    sampleSize integer

    Sample size of inspection

    serviceType string

    Service Type of the inspection

    status string

    Booking status

    toOrganizationId string

    Organization ID which the booking is booked to

    toOrganizationName string

    Organization name which the booking is booking to

    unit string

    Unit used in inspections e.g piece

    updatedDate date-time

    Last updated date of the booking

    vendorInformation

    object

    Information on the Vendor or Supplier in the booking

    address string
    city string

    contact

    object

    nullable

    contactId string
    email string
    mobileNumber string
    name string
    telephoneNumber string
    country string
    localOrganizationId string

    Local Custom ID of the organization

    localOrganizationIds string[]nullable

    The list of all connected Local Custom IDs of the organization

    name string
    organizationId string
    workflowName stringnullable

    Workflow name used for the booking

Loading...