Purchase Orders

Cancel Goodsin

Cancel a goodsin.

PUT

/v1/purchase_orders/goodsin/{id}/cancel

Cancel Goodsin

curl --request PUT \
  --url https://public-api.bladepro.io/v1/purchase_orders/goodsin/{id}/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "data": {
    "booking_approved": "2019-11-25T14:52:56.000Z",
    "booking_approved_by": 1,
    "booking_requested": "2019-11-25T14:52:56.000Z",
    "check_in_by": "2019-11-25T14:52:56.000Z",
    "checkin_completed": "2019-11-25T14:52:56.000Z",
    "checkin_started": "2019-11-25T14:52:56.000Z",
    "container_shipment": true,
    "container_size": "full",
    "created": "2019-11-25T14:52:56.000Z",
    "expected_cartons": 3200,
    "expected_delivery_date": "2019-11-25T14:52:56.000Z",
    "expected_delivery_time_slot": "am",
    "expected_pallets": 32,
    "id": 174,
    "ignore_from_billing": false,
    "is_third_party": false,
    "lock_user_id": 1,
    "modified": "2019-11-25T14:52:56.000Z",
    "port_id": 4,
    "preferred_delivery_date": "2019-11-25T14:52:56.000Z",
    "preferred_delivery_time_slot": "am",
    "purchase_order_goodsin_shipping_term_id": 1,
    "putaway_completed": "2019-11-25T14:52:56.000Z",
    "putaway_started": "2019-11-25T14:52:56.000Z",
    "received_cartons": 3200,
    "received_container": "20FT",
    "received_pallets": 32,
    "receiving_completed": "2019-11-25T14:52:56.000Z",
    "receiving_started": "2019-11-25T14:52:56.000Z",
    "returns_damaged_count": 0,
    "returns_unidentifiable_count": 0,
    "shipping_company": "DHL",
    "shipping_method": "sea",
    "source": "API",
    "status": "completed",
    "third_party_contact_name": null,
    "third_party_emails": null,
    "tracking_number": "DHL-TN-1209341234",
    "transport_costs_locked": "2019-11-25T14:52:56.000Z",
    "unique_booking_reference": "UQBR-2020/10934934"
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::PURCHASE-ORDERS::MANAGE

Path Parameters

idstringrequired

Path parameter: id

Pattern: [1-9][0-9]{0,}

Body

reasonstringrequired

Reason for cancellation.

Response

successful operation

booking_approvedany

Booking approved date.

booking_approved_bynumber

User ID.

booking_requestedany

Booking requested date.

check_in_byany

Check in by date.

checkin_completedany

Date of the end of checkin.

checkin_startedany

Date of the start of checkin.

consignment_qualitiesany

Quality descriptions.

container_shipmentboolean

Is this a container shipment?

container_sizeenum<string>

Size of the container.

Available options: none, half, full

containersany

Received containers.

createdany

Created date.

expected_cartonsnumber

Number of expected cartons.

expected_delivery_dateany

Expected delivery date.

expected_delivery_time_slotenum<string>

Expected delivery time slot.

Available options: am, pm

expected_palletsnumber

Number of expected pallets.

idnumber

ID.

ignore_from_billingboolean

Should the goodsin be ignored from billing?

is_third_partyboolean

Is this a third party goodsin?

itemsany

Received items.

lock_user_idnumber

ID of the locking user.

modifiedany

Last modified date.

portobject

Shipping port.

Show child attributes

port_idnumber

ID of the port.

preferred_delivery_dateany

Preferred delivery date.

preferred_delivery_time_slotenum<string>

Preferred delivery time slot.

Available options: am, pm

purchase_order_goodsin_shipping_term_idnumber

Shipping term ID.

putaway_completedany

Date of the end of putaway.

putaway_startedany

Date of the start of putaway.

received_cartonsnumber

Number of received cartons.

received_containerenum<string>

Type of received container.

Available options: 20FT, 40FT, 40FT-HC

received_palletsnumber

Number of received pallets.

receiving_completedany

Date of the end of receving.

receiving_startedany

Date of the start of receving.

returns_damaged_countnumber

The amount returned because of damage.

returns_unidentifiable_countnumber

The amount returned because the items had been unidentifiable.

shipping_companystring

Shipping company.

shipping_methodenum<string>

Shipping method.

Available options: air, sea, road,

sourcestring

Source.

statusenum<string>

Goodsin status.

Available options: awaiting_booking, awaiting_shipping, awaiting_receiving, awaiting_checkin, awaiting_putaway, completed, cancelled, awaiting_collection

third_party_contact_namestring

Third party contact names.

third_party_emailsstring

Third party email addresses.

tracking_numberstring

Tracking number.

transport_costs_lockedany

Date the transport costs have been locked on.

unique_booking_referencestring

Booking reference.

Still need help? Share an idea