@one-view/pd-oneview-order-status-history-types v0.0.5

FORMAT: 1A VERSION: 1.0.0 HOST: https://api.pd-oneview.net/order-status-history

pd-oneview-order-status-history

backend for oneview order-status-history plugin

Delivery Status histories /v1/{orderCode}/histories{?region}

Delivery status histories information

• Parameters
  • orderCode (required, string, vsba-nhas)
  • region (string, optional)
    • Default: FP_SG

• Attributes (DeliveryStatusHistories)

Get delivery histories GET

• Request

  • Headers

      Authorization: bearer token
      X-Contact-Id: case-id

• Response 200 (application/json)

  • Attributes (DeliveryStatusHistories)

• Response 400 (application/json)

  • Attributes (Error_400)

• Response 403 (application/json)

  • Attributes (Error_403)

• Response 404 (application/json)

  • Attributes (Error_404)

• Response 500 (application/json)

  • Attributes (Error_500)

Data Structures

int32 (number)

int64 (number)

Error (object)

• errorCode : 401 (int64)
• errorMessage : not authorize (string)

Error_401 (object)

• errorCode : 401 (int64)
• errorMessage : not authorize (string)

Error_404 (object)

• errorCode : 404 (int64)
• errorMessage : not found (string)

Error_403 (object)

• errorCode : 403 (int64)
• errorMessage : forbidden (string)

Error_400 (object)

• errorCode : 400 (int64)
• errorMessage : bad request (string)

Error_500 (object)

• errorCode : 500 (int64)
• errorMessage : internal server error (string)

DeliveryStatusHistories

• histories (arrayDeliveryStatus)

DeliveryStatus

• name : DELIVERED (string, required) - status name
• timestamp : 1572499999 (int64) - status timestamp
• isComplete : false (boolean) - is this status already complete or not
• description : Just Now (string, required) - status description